Zum Hauptinhalt springen
GET
Get a list of customers

Autorisierungen

Authorization
string
header
erforderlich

The access token received from the authorization server in the OAuth 2.0 flow.

Abfrageparameter

include
string

Comma-separated. Allowed: customer_account, communities, model_identifiers, custom_field_values, business, business.logo_image, business.billing_address, delivery_address, tags, organization, master_customer, master_customer.organization

page[number]
integer
page[size]
integer
sort
string

Allowed: first_name, last_name, email, created_at

Full-text search across name, email, and phone

filter[email]
string

Filter by exact email address

filter[mobile]
string

Filter by exact mobile number (E.164 format, e.g. +491701234567)

filter[community]
string

Filter by community UUID

filter[custom_fields]
object

Filter by custom field values. See the custom field filter syntax.

filter[tags]
string[]

One or more tag IDs; matches records that carry any of them. Use repeated-bracket form (filter[tags][]=12) or a comma-separated list.

filter[exclude_linked]
boolean

Leave out customers linked to a master customer in another organization of the group, so a master organization's group-wide list shows each person once. Also accepted as the plain query flag exclude_linked=1, which saved table views cannot override.

filter[organizations]
integer[]

Master organizations only: narrow the group-wide list to these organization IDs. See Master organizations.

filter[account_ids]
string[]

Customers of the given customer accounts, for example the members of a team subscription. Use repeated-bracket form (filter[account_ids][]=12).

o
string

Organization ID

Antwort

OK

data
Customer · object

A customer who makes bookings. Can be created by admins or through the booking flow.