Skip to main content
GET
List clients

Authorizations

Authorization
string
header
required

Bearer authorization header: Bearer <token>, where <token> is the access token received from the authorization server at the end of the OAuth 2.0 flow.

Headers

X-Qonto-Staging-Token
string

Required only for Sandbox API requests; to get one, please sign up to the Developer Portal.

Query Parameters

filter[]
object

Clients can be filtered based on their tax_identification_number, vat_number, or email. The response will return exact and case-insensitive match(es).
Clients can also be filtered based on their name. The response will return exact and partial matches, case-insensitive and accent-insensitive match(es). When type is individual or freelancer, name consists of the concatenation of first_name & " " & last_name. The value must at least contain 2 characters minimum.

filter[updated_at_from]
string<date-time>

Clients can be filtered by their updated_at property. This filter can be used in combination with the updated_at_to query parameter to get clients updated within a specific timeframe. Please use a valid date time format (ISO 8601 for instance).

Example:

"2022-02-01T12:01:02Z"

filter[updated_at_to]
string<date-time>

Clients can be filtered by their updated_at property. This filter can be used in combination with the updated_at_from query parameter to get clients updated within a specific timeframe. Please use a valid date time format (ISO 8601 for instance).

Example:

"2022-04-23T16:23:00Z"

page
integer

Returned page (cf. Pagination).

Example:

25

per_page
integer

Number of clients per page (cf. Pagination).

Example:

25

sort_by
enum<string>
default:name:asc

Clients can be sorted by their created_at / updated_at / name property in 2 possible orders: asc (Ascending) / desc (Descending).

Available options:
created_at:asc,
created_at:desc,
updated_at:asc,
updated_at:desc,
name:asc,
name:desc

Response

Returns the list of clients.

clients
object[]
meta
object

Metadata for paginated client responses.

Note: this endpoint returns the previous-page field as previous_page (rather than prev_page, used elsewhere in the Business API) for backward compatibility with the long-standing clients API. next_page and previous_page are always present and are null on the last/first page.