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,
    })

    # 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

Query Parameters

​
email
string
​
externalId
string
​
search
string
​
country
string
​
linkId
string
​
includeExpandedFields
boolean
​
sortBy
enum<string>
default:createdAt
Available options:
createdAt,
saleAmount
​
sortOrder
enum<string>
default:desc
Available options:
asc,
desc
​
page
number
default:1
Required range: x > 0
Example:
​
pageSize
number
default:100
Required range: 0 < x <= 100
Example:

Response

​
id
string
required
​
externalId
string
required
​
name
string
required
​
createdAt
string
required
​
email
string | null
​
avatar
string | null
​
country
string | null
​
sales
number | null
​
saleAmount
number | null
​
link
object | null
​
programId
string | null
​
partner
object | null
​
discount
object | null