Skip to main content
GET
/
reward_fulfillments
List reward fulfillments
curl --request GET \
  --url https://api.smile.io/v1/reward_fulfillments \
  --header 'Authorization: Bearer <token>'
{
  "reward_fulfillments": [
    {
      "id": 625478984,
      "name": "$5 off coupon",
      "code": "5off-e26d02e39149",
      "customer_id": 304169228,
      "fulfillment_status": "issued",
      "image_url": "https://platform-images.smilecdn.co/9283449.png",
      "action_text": "<string>",
      "action_url": "<string>",
      "usage_instructions": "Use this discount code on your next order!",
      "terms_and_conditions": "Reward expires on June 7, 2025. Reward can only be used on purchase of $50 or more. Reward can only be used on select product collections.",
      "expires_at": "2025-06-07T23:59:59.999Z",
      "usage_status": "unused",
      "used_at": "2023-11-07T05:31:56Z",
      "created_at": "2024-12-07T20:15:27.893Z",
      "updated_at": "2024-12-07T20:15:27.893Z"
    }
  ],
  "metadata": {
    "next_cursor": "aWQ6MixkaXJlY3Rpb246bmV4dA==",
    "previous_cursor": ""
  }
}

Documentation Index

Fetch the complete documentation index at: https://dev.smile.io/llms.txt

Use this file to discover all available pages before exploring further.

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