GET
/
customers
/
{id}
Python
from dub import Dub


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

    res = d_client.customers.get(request={
        "id": "<id>",
    })

    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,
    "description": "<string>",
    "couponId": "<string>",
    "couponTestId": "<string>",
    "partnersCount": 123
  }
}

Authorizations

Authorization
string
header
required

Default authentication mechanism

Path Parameters

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

Query Parameters

includeExpandedFields
boolean

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

Response

The customer object.

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.

programId
string | null
partner
object | null
discount
object | null