BObookingexperts
Contacts

GET contacts

Changed on

Returns contacts of the organization

get/v3/contacts

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[contact]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[locale]string

Filter on locale

filter[email]string

Filter on email

filter[is_company]string

Filter on is_company

filter[title]string

Filter on title

filter[first_name]string

Filter on first_name

filter[last_name]string

Filter on last_name

filter[company]string

Filter on company

filter[vat_nr]string

Filter on vat_nr

filter[tin]string

Filter on tin

filter[business_registration_number]string

Filter on business_registration_number

filter[nationality]string

Filter on nationality

filter[date_of_birth]string

Filter on date_of_birth

filter[receive_newsletter]string

Filter on receive_newsletter

filter[bookings_marketing_consent]string

Filter on bookings_marketing_consent

filter[bookings_relevant_marketing_consent_until]string

Filter on bookings_relevant_marketing_consent_until

filter[address_line_1]string

Filter on address_line_1

filter[address_line_2]string

Filter on address_line_2

filter[postalcode]string

Filter on postalcode

filter[city]string

Filter on city

filter[country_code]string

Filter on country_code

filter[address_subdivision]string

Filter on address_subdivision

filter[iban]string

Filter on iban

filter[bic]string

Filter on bic

filter[phone]string

Filter on phone

filter[mobile_phone]string

Filter on mobile_phone

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

ContactCollectionResponse

Example response

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

Changes