GET
/
v2
/
clients
curl --request GET \
  --url https://thirdparty.qonto.com/v2/clients \
  --header 'Authorization: Bearer <token>'
{
  "clients": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "type": "company",
      "email": "john.doe@qonto.eu",
      "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>",
      "locale": "fr"
    }
  ],
  "meta": {
    "current_page": 2,
    "next_page": "<any>",
    "prev_page": "<any>",
    "total_pages": 2,
    "total_count": 150,
    "per_page": 100
  }
}

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). <br>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.

​
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 / name property in 2 possible orders: asc (Ascending) / desc (Descending).

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

Response

200
application/json
Returns the list of clients.

The response is of type object.