List all rewards

get

https://api.partnerstack.com/api/v2/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

Time	Status	User Agent
Retrieving recent requests…

Loading…

📘
Pagination
A cursor for use in pagination. starting_after is an item key that defines your place in the list.
For instance, if you make a list request and receive 100 items, then the last item with "key":"rwrd_f4Jmxb7LmvhERZ", can be used in your subsequent call as the parameter value to fetch the next page of results: ?starting_after=rwrd_f4Jmxb7LmvhERZ.
Click here for more info about pagination.

Query Params

company_key

string

Company key in which the results are filtered by.

payment_status

string

enum

The payment status of the rewards

Allowed:

max_created

int64

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

min_created

int64

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

order_by

string

enum

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

Allowed:

group_key

string

Group key in which the results are filtered by

customer_key

string

Customer key in which the results are filtered by

invoice_key

string

Invoice key in which the results are filtered by

status

string

The status of the rewards

exclude_drip_rewards

string

Flag if drip rewards should be included into the results

hide_archived_rewards

boolean

Flag to hide rewards that have been archived

empty_line_id

boolean

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

keywords

string

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

description

string

Text that the description must contain

distinct_description

boolean

Flag the returned results should have distinct descriptions or not

distinct_decline_reason

boolean

Flag the returned results should have distinct decline reasons or not

decline_reason

string

Text that the decline_reason must contain

invoiceable

boolean

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

currency

string

The currency of the rewards

limit

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.

starting_after

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.

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

Pagination

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

400Bad Request Error

401Unauthorized Error

403Forbidden Error

404Not Found Error

500Internal Server Error