<- Loyalty API

Loyalty API

Search loyalty rewards

POST

 /v2/loyalty/rewards/search

Searches for loyalty rewards.

This endpoint accepts a request with no query filters and returns results for all loyalty accounts. If you include a query object, loyalty_account_id is required and status is optional.

If you know a reward ID, use the RetrieveLoyaltyReward endpoint.

Search results are sorted by updated_at in descending order.

Permissions:LOYALTY_READ

Guide

Search loyalty rewards

Try in API Explorer
Link to section

Request body

Example code

Link to section

query

The search criteria for the request. If empty, the endpoint retrieves all loyalty rewards in the loyalty program.

Link to section

limit

integer(32-bit)

The maximum number of results to return in the response. The default value is 30.

Min
1
Max
30
Link to section

cursor

string

A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. For more information, see Pagination.

Link to section

Response fields

Link to section

errors

Any errors that occurred during the request.

Link to section

rewards

The loyalty rewards that satisfy the search criteria. These are returned in descending order by updated_at.

Link to section

cursor

string

The pagination cursor to be used in a subsequent request. If empty, this is the final response.