Skip to main content
GET
List rewards
List the custom and managed rewards in a program’s catalog. Use status=ACTIVE to show active rewards in your application. By default, the list excludes both rewards with status=ARCHIVED and soft-deleted rewards. This also applies when you omit the status filter. Pass include_archived=true to include both, or combine it with status=ARCHIVED to list only archived rewards. An active reward is still subject to availability windows, participant limits, balance, account readiness, and program limits at redemption time. This endpoint does not check an individual participant’s eligibility. Use reward_type=GIFT_CARD to show gift cards or reward_type=CUSTOM to show rewards you created yourself. Prepaid cards use PREPAID_CARD; donations use CHARITY. You can combine a type with asset_id, a partial category name, and redemption_type to narrow the catalog. All filters apply before pagination. Use search to find rewards by name. For alphabetical order, set sort_by=name&sort_dir=asc; the API defaults to newest first. Follow pagination.next_cursor with the same filters and sorting to retrieve the next page. Start again without a cursor when changing the view.
See Rewards catalog for custom rewards and Gift cards for showing and redeeming cards.

Managed rewards

Managed rewards have kind: "PROVIDER" and auto_managed: true. Their category identifies GIFT_CARD, PREPAID_CARD, or CHARITY. reward_source_id and fulfillment_product_id identify their configuration; use the reward’s own id when redeeming. The same fields are returned by Get a reward. An AMOUNT_BASED gift card lets the participant choose a supported value. A fixed list of denominations alone does not make it UNIT_BASED. Setting one fixed value and currency in product settings creates a UNIT_BASED reward, whose fulfillment details contain only that value and currency.

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
reward_type
enum<string>

Filter by reward type, independent of the fulfillment account

Available options:
CUSTOM,
GIFT_CARD,
PREPAID_CARD,
CHARITY
asset_id
string<uuid>

Filter by the asset used to pay for the reward

category
string

Filter by category (case-insensitive partial match)

redemption_type
enum<string>

Filter by redemption method

Available options:
UNIT_BASED,
AMOUNT_BASED
include_archived
boolean
default:false

Include archived and soft-deleted 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