Skip to main content
GET
List Clients
The search query parameter takes a list of words and enables you to only return clients whose code or name contains all those words.

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