Skip to main content
GET
List all rewards

Authorizations

Authorization
string
header
required

Authenticate with the bearer_token obtained from the authentication endpoint.

Query Parameters

program_id
string

Filter by program.

device_id
string

Filter by device.

status
enum<string>

Filter by status, for example ACCRUED for the entries that await your approval.

Available options:
ACCRUED,
APPROVED,
PAID
start_time
string<date-time>

Start time, in UTC.

end_time
string<date-time>

End time, in UTC.

limit
integer
default:30

Maximum number of objects to return per page. Between 1 and 100, default 30. Values above 100 are clamped to 100.

Required range: 1 <= x <= 100
cursor
string

Pagination cursor. Pass next_cursor from the previous response unchanged; omit for the first page. A cursor used with different parameters returns 400 cursor_invalid.

Response

Reward list response.

object
enum<string>
required

Object type, list.

Available options:
list
Example:

"list"

url
string
required

URL slug for the object.

Example:

"/rewards"

next_cursor
string | null
required

Cursor for the next page. Pass it as cursor. null on the last page. Page until it is null, even if data is short or empty.

Example:

"djF8ZXZ0fGE5ZjN8NjYxNjc3ODdjMTY1MmIzZmJlYmE1ZjAx"

data
Reward · object[]
required