Skip to main content
GET
List reward fulfillments
This endpoint requires the scope.
Results are sorted by id in descending order. This endpoint is commonly used to display a list of a customer’s rewards (e.g. discount codes).

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

customer_id
integer

Filter results to only reward fulfillments with the provided Smile customer ID.

fulfillment_status
enum<string>

Filter results to only reward fulfillments whose fulfillment status matches the provided value.

Available options:
pending,
issued,
cancelled,
failed
usage_status
enum<string>

Filter results to only reward fulfillments whose usage status matches the provided values.

Available options:
used,
unused,
untracked
updated_at_min
string<date-time>

Filter results to only reward fulfillments updated after the provided date and time.

limit
integer
default:50

The maximum number of reward fulfillments to retrieve.

Required range: 1 <= x <= 250
Example:

1

cursor
string

Cursor for the page of reward fulfillments to retrieve.

Response

200 - application/json
reward_fulfillments
object[]
metadata
object