List customers

GET 
/affiliate-manager/:locationId/affiliates/:affiliateId/customers

Retrieve the list of customers for an affiliate.

Request

Version stringrequired

API Version

Available optionsv3

locationId stringrequired

Location Id

affiliateId stringrequired

Affiliate Id

query string

query

status string

Customer Type

campaignId string

Campaign Id

skip integer

Number of customers to skip

Possible values: >= 0

Default value:0

limit integer

Number of customers to return, maximum 100

Possible values: >= 1 and <= 100

Default value:10

commissionStatus string

Commission Status

application/json

Successful response

application/json

Schema

Schema

customersobject[]required

Customers associated with the affiliate

metaobjectrequired

Pagination metadata

Example (auto)

{
  "customers": [
    {
      "_id": "ve9EPM428h8vShlRW1KT",
      "locationId": "ve9EPM428h8vShlRW1KT",
      "affiliateId": "ve9EPM428h8vShlRW1KT",
      "campaignId": "ve9EPM428h8vShlRW1KT",
      "contactId": "ve9EPM428h8vShlRW1KT",
      "firstName": "John",
      "lastName": "Doe",
      "name": "John Doe",
      "email": "[email protected]",
      "phone": "+15551234567",
      "type": "customer",
      "deleted": false,
      "isDisabled": false,
      "revenue": 100,
      "commissionAmount": 25,
      "planName": "Basic Plan",
      "currency": "USD",
      "locationCurrency": "USD",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z"
    }
  ],
  "meta": {
    "count": 1
  }
}