Get a list of clients

OAuth scope: client.read

---

Get information about client(s) that constitute(s) the addressee of client invoices (or other products, such as SEPA Direct Debit) for a particular organization based on a search on attributes. See further details below.

---

Price plans: this endpoint is available for all Qonto price plans.

---

The response contains attributes of the client entered in the request, along with additional fields that are computed by Qonto, including the associated client id.

---

Filtering

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.

Sorting

• Clients can be sorted by created_at, name
• Two values are available: asc (Ascending) / desc (Descending)
• By default, the order used to sort is name, asc

Pagination

• The default number of items per page is 100, max items per page is 100. Pagination data is returned in the response : See Schema here.

{
  "clients": [
    {
      "email": "john.doe@qonto.eu",
      "billing_address": {
        "street_address": "123 Main Street",
        "city": "Paris",
        "zip_code": "75009",
        "country_code": "fr"
      },
      "delivery_address": {
        "street_address": "123 Main Street",
        "city": "Paris",
        "zip_code": "75009",
        "country_code": "fr"
      },
      "locale": "fr"
    }
  ],
  "meta": {
    "current_page": 2,
    "prev_page": 1,
    "total_pages": 2,
    "total_count": 150,
    "per_page": 100
  }
}