Retrieve a list of customers
Retrieve a list of customers for the authenticated workspace.
Authorizations
Default authentication mechanism
Query Parameters
A case-sensitive filter on the list based on the customer's email
field. The value must be a string.
A case-sensitive filter on the list based on the customer's externalId
field. The value must be a string.
Whether to include expanded fields on the customer (link
, partner
, discount
).
Response
The unique ID of the customer. You may use either the customer's id
on Dub (obtained via /customers
endpoint) or their externalId
(unique ID within your system, prefixed with ext_
, e.g. ext_123
).
Unique identifier for the customer in the client's app.
Name of the customer.
The date the customer was created.
Email of the customer.
Avatar URL of the customer.
Country of the customer.
Was this page helpful?