List all rewards

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Partnership key in which the results are filtered by.

int64

Applies a maximum epoch timestamp (ms) filter to the response created_at.

int64

Applies a minimum epoch timestamp (ms) filter to the response created_at.

string
enum

The field in which the results are ordered by. A - prefix denotes that the results are in descending order.

Allowed:
string

Group key in which the results are filtered by

string

Customer key in which the results are filtered by

string

Invoice key in which the results are filtered by

string

The status of the rewards

string

Flag if drip rewards should be included into the results

boolean

Flag to hide rewards that have been archived

boolean

Flag if drip rewards returned have a line_id (invoice) attached or not

string

Free keywords that will filter on the followingReward key, Customer name, Partner first name, Partner last name, Partner email, Partner key

string

Text that the description must contain

boolean

Flag the returned results should have distinct descriptions or not

boolean

Flag the returned results should have distinct decline reasons or not

string

Text that the decline_reason must contain

boolean

Flag if the returned results should have only pending and approved rewards which do not have an associated payment line.

string

The currency of the rewards

string

Filter rewards by how they were created. Accepts a comma-separated list of values: manual, offer_trigger, import, drip.

integer
1 to 250
Defaults to 10

A limit on the number of items to be returned. Limits can range between 1 and 250, and the default is 10.

string

A cursor for use in pagination, starting_after takes in an item key and the subsequent call will return the following items in the list. This is mutually exclusive with ending_before.

string

A cursor for use in pagination, ending_before takes in an item key and the subsequent call will return the prior items in the list. This is mutually exclusive with starting_after.

Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json