GET Referred Customers

Endpoint

GET /api/affiliate/v1/customers

Requires an affiliate API token with customers:read.

GET /api/affiliate/v1/customers?limit=100&cursor=12345
Authorization: {JWT_TOKEN}

A customer is returned only when its brand matches the token brand and its affiliate attribution matches the authenticated affiliate code. The response intentionally excludes names, email addresses, phone numbers, addresses, identity documents, and other PII.

Query parameters

Name	Type	Required	Description
limit	int	No	Page size, default 100, maximum 500
cursor	int	No	Return records with a lower customer_id than this value

Response

{
  "rows": [
    {
      "customer_id": 12041,
      "status": 0,
      "lifecycle_stage": 2,
      "kyc_status": 1,
      "country": "CY",
      "campaign": "summer-2026",
      "utm_source": "partner-site",
      "utm_campaign": "summer-2026",
      "created_time": 1789344000
    }
  ],
  "has_more": true,
  "next_cursor": 12041
}

Errors

HTTP	Error	Description
401	INCORRECT_TOKEN	JWT signature or format is invalid
401	INVALID_AFFILIATE_API_TOKEN	Token record, owner, brand, scope, expiration, or active access check failed