Skip to main content
AffiliatesVersion: v3

List Affiliates

GET/affiliate-manager/{locationId}/affiliates

Retrieve the list of affiliates for a location.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:affiliate-manager.readonly
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3
Example:v3

Path Parameters

locationIdstringrequired

Location Id

Example:ve9EPM428h8vShlRW1KT

Query Parameters

querystring

Search affiliates by name or email

Example:John
activeboolean

Filter affiliates by active status

Default:false
Example:true
campaignIdstring

Filter affiliates by campaign ID

Example:63d376de11be1d26d38f7369
skipnumber

Number of records to skip for pagination

Possible values: >= 0

Default:0
Example:1
limitnumber

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:10
Example:10
fromDatestring

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

Example:2023-10-01
toDatestring

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

Example:2023-10-01

Response

application/json

Successful response

affiliatesobject[]required

Affiliate list

metaobjectrequired

Pagination metadata