Skip to main content
GET
List rewards
Returns all rewards in a program’s catalog. Archived rewards are excluded by default; pass include_archived=true to include them. Filter by status, use search to find rewards by name, and sort_by / sort_dir to control ordering.
For usage patterns and examples, see the Rewards Catalog guide.

Authorizations

X-API-Key
string
header
required

API key passed in the X-API-Key header.

Path Parameters

programId
string<uuid>
required

Program ID

Query Parameters

status
enum<string>

Filter by reward status

Available options:
DRAFT,
ACTIVE,
OUT_OF_STOCK,
ARCHIVED
include_archived
boolean
default:false

Include archived rewards in results

Search by reward name (partial match)

sort_by
enum<string>

Sort field

Available options:
created_at,
name
sort_dir
enum<string>

Sort direction

Available options:
asc,
desc
limit
integer
default:50

Maximum number of results (default 50, max 200)

Required range: x >= 1
cursor
string

Pagination cursor from previous response

Response

List of rewards

data
object[]

Data contains the list of items

pagination
object

Pagination contains cursor information for fetching more results