Skip to main content
GET
/
timmi-project
/
api
/
v4
/
clients
List Clients
curl --request GET \
  --url https://{host}/timmi-project/api/v4/clients \
  --header 'Authorization: <authorization>'
import requests

url = "https://{host}/timmi-project/api/v4/clients"

headers = {"Authorization": "<authorization>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://{host}/timmi-project/api/v4/clients', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/timmi-project/api/v4/clients",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/timmi-project/api/v4/clients"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://{host}/timmi-project/api/v4/clients")
  .header("Authorization", "<authorization>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://{host}/timmi-project/api/v4/clients")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body
{
  "items": [
    {
      "name": "<string>",
      "code": "<string>",
      "id": 123,
      "externalCode": "<string>",
      "owner": {
        "id": 2,
        "firstName": "<string>",
        "lastName": "<string>",
        "dtContractEnd": "<string>",
        "picture": {
          "href": "<string>"
        },
        "establishmentId": 2
      }
    }
  ],
  "next": "<string>",
  "prev": "<string>",
  "count": 1
}
{
  "type": "<string>",
  "title": "<string>",
  "traceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errors": {}
}
{
  "type": "<string>",
  "title": "<string>",
  "traceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errors": {}
}
{
  "type": "<string>",
  "title": "<string>",
  "traceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errors": {}
}
{
  "type": "<string>",
  "title": "<string>",
  "traceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errors": {}
}
The search query parameter takes a list of words and enables you to only return clients whose code or name contains all those words.
GET /api/v4/clients?organizationId=1&search=goo,compa&fields.root=count HTP/1.1

{
  "count": 2,
  "items": [
    {
      "id": 1,
      "name": "Google",
      "code": "World company"
    },
    {
      "id": 1,
      "name": "Google company",
      "code": "Alphabet Group"
  ]
}

Headers

Authorization
string
required

API key. Value must be formatted like so: lucca application={api_key}.

Query Parameters

organizationId
integer
required

Filter on a single organization unique identifier.

page
integer
default:1

Page number

Required range: x >= 1
limit
integer
default:10

Page size

fields.root
enum<string>

Return total items count (across all pages).

Available options:
count

Comma-separated list of codes / names to search for

code
string

Only returns clients whose code is strictly equal to sent value

Response

OK

items
The Client resource · object[]
next
string<uri> | null
prev
string<uri> | null
count
integer | null
Required range: x >= 0