Skip to main content
CommissionsVersion: v3

List Commissions

GET/affiliate-manager/{locationId}/commissions

Retrieve the list of commissions 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

campaignIdstring

Campaign Id

Example:6385d230f6d19db03eef6fb2
affiliateIdstring

Affiliate Id

Example:6385d230f6d19db03eef6fb2
statusCommissionStatus

Status

Available optionspendingapprovedpaiddenied
querystring

Query

skipnumber

Number of records to skip for pagination

Default:0
Example:1
limitnumber

Maximum number of records to return. Maximum allowed value is 100.

Default:10
Example:10
fromDatestring

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

Example:2023-10-01
toDatestring

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

Example:2023-10-01

Response

Successful response

commissionsobject[]required

Commission list

metaobject

Pagination metadata