Retrieve a customer

Retrieve a customer by ID for the authenticated workspace.

GET /customers/{id}

Try it

Python

Python

from dub import Dub


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

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

    # Handle response
    print(res)

200

{
  "id": "<string>",
  "externalId": "<string>",
  "name": "<string>",
  "createdAt": "<string>",
  "email": "<string>",
  "avatar": "<string>",
  "country": "<string>",
  "sales": 123,
  "saleAmount": 123,
  "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

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

200

application/json

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.

link · Link · object

Show child attributes

link. id · string · required

The unique ID of the short link.

link. domain · string · required

The domain of the short link. If not provided, the primary domain for the workspace will be used (or dub.sh if the workspace has no domains).

link. key · string · required

The short link slug. If not provided, a random 7-character slug will be generated.

link. shortLink · string<uri> · required

The full URL of the short link, including the https protocol (e.g. https://dub.sh/try).

link. url · string<uri> · required

The destination URL of the short link.

link. programId · string | null · required

The ID of the program the short link is associated with.

programId · string | null

partner · object

Show child attributes

partner. id · string · required

The partner's unique ID on Dub.

partner. name · string · required

The partner's full legal name.

Maximum string length: 190

partner. email · string | null · required

The partner's email address. Should be a unique value across Dub.

Maximum string length: 190

partner. image · string | null · required

The partner's avatar image.

discount · object

Show child attributes

discount. id · string · required

discount. amount · number · required

discount. type · enum<string> · required

Available options: percentage, flat

discount. maxDuration · number | null · required

discount. couponId · string | null · required

discount. couponTestId · string | null · required

discount. description · string | null

discount. partnersCount · number | null