List Affiliates

GET 
/affiliate-manager/:locationId/affiliates

Retrieve the list of affiliates for a location.

Request

Version stringrequired

API Version

Available options2023-02-21

locationId stringrequired

Location Id

query string

Search affiliates by name or email

active string

Filter affiliates by active status

Default value:false

campaignId string

Filter affiliates by campaign ID

skip number

Number of records to skip for pagination

Possible values: >= 0

Default value:0

limit number

Maximum number of records to return. Maximum allowed value is 100. A value of 0 is treated as the default of 10.

Possible values: >= 0 and <= 100

Default value:10

fromDate string

Filter affiliates created on or after this date (YYYY-MM-DD)

toDate string

Filter affiliates created on or before this date (YYYY-MM-DD)

application/json

Successful response

application/json

Schema

Schema

affiliatesobject[]required

Affiliate list

metaobjectrequired

Pagination metadata

Example (auto)

{
  "affiliates": [
    {
      "_id": "63d147176c5bbc30e9e091a4",
      "firstName": "John",
      "lastName": "Doe",
      "email": "[email protected]",
      "phone": "+1 888 888-8888",
      "locationId": "ve9EPM428h8vShlRW1KT",
      "active": true,
      "contactId": "ve9EPM428h8vShlRW1KT",
      "createdAt": "2024-06-16T00:00:00.000Z"
    }
  ],
  "meta": {
    "count": 10
  }
}