Skip to main content
GET
/
v2
/
clients
List clients
curl --request GET \
  --url https://thirdparty.qonto.com/v2/clients \
  --header 'Authorization: Bearer <token>'
{
  "clients": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "John Doe",
      "first_name": "John",
      "last_name": "Doe",
      "phone_number": "+33123456789",
      "phone": {
        "country_code": "+33",
        "number": "123456789"
      },
      "kind": "company",
      "type": "company",
      "email": "john.doe@qonto.eu",
      "extra_emails": [
        "additional@email.com",
        "backup@email.com"
      ],
      "currency": "EUR",
      "e_invoicing_address": "987654321",
      "vat_number": "<string>",
      "tax_identification_number": "<string>",
      "address": "<string>",
      "city": "<string>",
      "zip_code": "<string>",
      "province_code": "<string>",
      "country_code": "<string>",
      "billing_address": {
        "street_address": "123 Main Street",
        "city": "Paris",
        "zip_code": "75009",
        "province_code": "<string>",
        "country_code": "fr"
      },
      "delivery_address": {
        "street_address": "123 Main Street",
        "city": "Paris",
        "zip_code": "75009",
        "province_code": "<string>",
        "country_code": "fr"
      },
      "recipient_code": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "locale": "fr"
    }
  ],
  "meta": {
    "current_page": 2,
    "next_page": 3,
    "prev_page": 1,
    "total_pages": 11,
    "total_count": 210,
    "per_page": 20
  }
}

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 responses