BObookingexperts
Customers

GET customers

Changed on

Returns customers that are part of the current organization

get/v3/customers

Request

Query parameters

page[number]integer

Page number

page[size]integer

Page size

sortstring

Sort. Specify a comma separated list of attributes to sort on. Prefix attribute with a - to sort in descending order. Allowed attributes: id, created_at, updated_at

fields[customer]string

Fieldset. Specify a comma separated list of attributes to return

includestring

Includes list. Specify a comma separated list of resources to include.

filter[id]string

Filter on ID

filter[receive_newsletter]string

Filter on receive_newsletter

filter[title]string

Filter on title

filter[first_name]string

Filter on first_name

filter[last_name]string

Filter on last_name

filter[phone]string

Filter on phone

filter[email]string

Filter on email

filter[is_company]string

Filter on is_company

filter[company]string

Filter on company

filter[vat_nr]string

Filter on vat_nr

filter[business_registration_number]string

Filter on business_registration_number

filter[date_of_birth]string

Filter on date_of_birth

filter[postalcode]string

Filter on postalcode

filter[city]string

Filter on city

filter[country_code]string

Filter on country_code

filter[locale]string

Filter on locale

filter[created_at]string

Filter on created_at

filter[updated_at]string

Filter on updated_at

filter[labels]string

Filter on labels. Specify a comma separated list of IDs to filter on.

Headers

Accept-Languagestring

Supported languages. A comma separated list with one or more of the following locales: cs, da-DK, de, de-AT, de-CH, en-US, en-GB, es, fr, fr-BE, fr-LU, it, nb, nl, nl-BE, pl, pt, tr, en, da. Default: 'en'.

Response

CustomerCollectionResponse

Example response

{
  "data": [
    {
      "id": "1",
      "type": "customer",
      "attributes": {
        "title": "mr",
        "country_code": "NL",
        "locale": "cs"
      },
      "relationships": {
        "labels": {
          "data": [
            {
              "type": "label"
            }
          ]
        }
      }
    }
  ],
  "included": [
    {
      "id": "1",
      "type": "label"
    }
  ]
}

Changes

  • ff81bc4fefa9Revision changes
    • warning

      added the new da-DK enum value to the /// response property for the response status

    • warning

      added the new en-GB enum value to the /// response property for the response status

    • warning

      added the new en-US enum value to the /// response property for the response status

    • info

      added the optional property /// to the response with the status

    • info

      response property data/items/attributes/debtor_code deprecated