List commissions

Returns a list of your commissions. The commissions are returned sorted by creation date, with the most recent commissions appearing first.

Request

Method

URL

GET

https://api.getrewardful.com/v1/commissions

Optional parameters

Parameter

Description

affiliate_id

Show commissions for the specified affiliate.

state

Show commissions that are currently in the specified states. Valid values are "due", "pending", and "paid". Pass state[] to specify multiple states.

page

Pagination cursor specifying which page to fetch.

limit

How many results to return per page. Default is 25, maximum is 100.

expand

Which object(s) to expand in response data. See below for available objects.

Expandable objects

Parameter

Description

sale

Includes the sale as a nested object for each commission in the list. The sale object will include details about the referral, link, affiliate, etc.

campaign

Include the details about the campaign this commission is associated with.

Examples

List all commissions

curl --request GET \
--url https://api.getrewardful.com/v1/commissions \
-u YOUR_API_SECRET:

List all commissions and include nested sale object

curl --request GET \
--url https://api.getrewardful.com/v1/commissions?expand[]=sale \
-u YOUR_API_SECRET:

List commissions for a specific affiliate

curl --request GET \
--url https://api.getrewardful.com/v1/commissions?affiliate_id=b533bfca-7c70-4dec-9691-e136a8d9a26c \
-u YOUR_API_SECRET:

List commissions with a "paid" state

curl --request GET \
--url https://api.getrewardful.com/v1/commissions?state=paid \
-u YOUR_API_SECRET:

List commissions with a "due" or "pending" state

curl --request GET \
--url https://api.getrewardful.com/v1/commissions?state[]=due&state[]=pending \
-u YOUR_API_SECRET:

Pagination: request page 3 with 50 results per page

curl --request GET \
--url https://api.getrewardful.com/v1/commissions?page=3&limit=50
-u YOUR_API_SECRET: