Skip to main content
GET
/
customers
Python
from dub import Dub


with Dub(
    token="DUB_API_KEY",
) as d_client:

    res = d_client.customers.list(request={
        "page_size": 50,
    })

    assert res is not None

    # Handle response
    print(res)
[
  {
    "id": "<string>",
    "externalId": "<string>",
    "name": "<string>",
    "email": "<string>",
    "avatar": "<string>",
    "country": "<string>",
    "sales": 123,
    "saleAmount": 123,
    "createdAt": "<string>",
    "link": {
      "id": "<string>",
      "domain": "<string>",
      "key": "<string>",
      "shortLink": "<string>",
      "url": "<string>",
      "programId": "<string>"
    },
    "programId": "<string>",
    "partner": {
      "id": "<string>",
      "name": "<string>",
      "email": "<string>",
      "image": "<string>"
    },
    "discount": {
      "id": "<string>",
      "amount": 123,
      "type": "percentage",
      "maxDuration": 123,
      "couponId": "<string>",
      "couponTestId": "<string>",
      "description": "<string>",
      "partnersCount": 123
    }
  }
]

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. Takes precedence over externalId.

​
externalId
string

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

​
search
string

A search query to filter customers by email, externalId, or name. If email or externalId is provided, this will be ignored.

​
country
string

A filter on the list based on the customer's country field.

​
linkId
string

A filter on the list based on the customer's linkId field (the referral link ID).

​
includeExpandedFields
boolean

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

​
sortBy
enum<string>
default:createdAt

The field to sort the customers by. The default is createdAt.

Available options:
createdAt,
saleAmount
​
sortOrder
enum<string>
default:desc

The sort order. The default is desc.

Available options:
asc,
desc
​
page
number
default:1

The page number for pagination.

Required range: x > 0
Example:

1

​
pageSize
number
default:100

The number of items per page.

Required range: 0 < x <= 100
Example:

50

Response

The list of customers.

​
id
string
required

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).

​
externalId
string
required

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

​
name
string
required

Name of the customer.

​
createdAt
string
required

The date the customer was created.

​
email
string | null

Email of the customer.

​
avatar
string | null

Avatar URL of the customer.

​
country
string | null

Country of the customer.

​
sales
number | null

Total number of sales for the customer.

​
saleAmount
number | null

Total amount of sales for the customer.

​
link
object | null
​
programId
string | null
​
partner
object | null
​
discount
object | null