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. Takes precedence over externalId
.
A case-sensitive filter on the list based on the customer's externalId
field. The value must be a string. Takes precedence over search
.
A search query to filter customers by email, externalId, or name. If email
or externalId
is provided, this will be ignored.
A filter on the list based on the customer's country
field.
A filter on the list based on the customer's linkId
field (the referral link ID).
Whether to include expanded fields on the customer (link
, partner
, discount
).
The field to sort the customers by. The default is createdAt
.
createdAt
, saleAmount
The sort order. The default is desc
.
asc
, desc
The page number for pagination.
x > 0
1
The number of items per page.
0 < x <= 100
50
Response
The list of customers.
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.
Total number of sales for the customer.
Total amount of sales for the customer.