My Extole LoginGithub
API Reference

List rewards

get
https://api.extole.io/v2/rewards

Returns reward records for the client matching the specified query parameters.

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

Filter by reward state(s). Repeat for multiple values (e.g. EARNED, FULFILLED).

string

Filter by Extole reward supplier id(s). Repeat for multiple values.

string

Filter by partner-assigned reward supplier id(s). Repeat for multiple values.

string

Filter by Extole person id(s). Repeat for multiple values.

string

Filter by Extole action id(s). Repeat for multiple values.

string

Filter by root event id(s). Repeat for multiple values.

string

Filter by partner-assigned reward id(s). Repeat for multiple values.

string

Filter by reward type(s). Repeat for multiple values.

boolean

When true (default), include only rewards that were successfully fulfilled.

string

ISO 8601 time interval to restrict results to a date range (e.g. P30D for last 30 days).

int32

Maximum number of rewards to return. Defaults to 100.

int32

Number of rewards to skip for pagination. Defaults to 0.

Responses

Updated about 1 month ago

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

Updated about 1 month ago