GET
/
customers

Authorizations

Authorization
string
header
required

Default authentication mechanism

Query Parameters

email
string

A case-sensitive filter on the list based on the customer's email field. The value must be a string.

externalId
string

A case-sensitive filter on the list based on the customer's externalId field. The value must be a string.

includeExpandedFields
boolean

Whether to include expanded fields on the customer (link, partner, discount).

Response

200 - application/json
createdAt
string
required

The date the customer was created.

externalId
string
required

Unique identifier for the customer in the client's app.

id
string
required

The unique identifier of the customer in Dub.

name
string
required

Name of the customer.

avatar
string | null

Avatar URL of the customer.

country
string | null

Country of the customer.

discount
object | null
email
string | null

Email of the customer.

partner
object | null