Rewards

List rewards

List rewards for a program.

get/v1/programs/{program_id}/rewards

Request

  • Base URL: https://api.scrip.dev
  • URL: https://api.scrip.dev/v1/programs/{program_id}/rewards
  • Auth: HTTP bearer

Path parameters

program_idstring uuid required

The program's id.

Query parameters

status'DRAFT' | 'ACTIVE' | 'OUT_OF_STOCK' | 'ARCHIVED'

Filter by reward status

reward_type'CUSTOM' | 'GIFT_CARD' | 'PREPAID_CARD' | 'CHARITY'

Filter by reward type, independent of the fulfillment account

asset_idstring uuid

Filter by the asset used to pay for the reward

categorystring

Filter by category (case-insensitive partial match)

redemption_type'UNIT_BASED' | 'AMOUNT_BASED'

Filter by redemption method

include_archivedboolean

Include archived and soft-deleted rewards in results

searchstring

Search by reward name (partial match)

sort_by'created_at' | 'name'

Sort field

sort_dir'asc' | 'desc'

Sort direction

limitinteger

Return at most this many records, from 1 to 200, default 50.

cursorstring

The next_cursor from the previous response, valid only with the same endpoint and filters.

created_afterstring date-time

Return only records created after this time, RFC 3339.

created_beforestring date-time

Return only records created before this time, RFC 3339.

Response

List of rewards

Example response

{
  "data": [
    {
      "asset_id": "a3bb189e-8bf9-4c8b-9be0-6b5d2f4e7a02",
      "available_from": "2027-01-01T00:00:00Z",
      "available_until": "2027-12-31T23:59:59Z",
      "category": "Gift Cards",
      "committed_units": 42,
      "created_at": "2027-01-15T10:30:00Z",
      "delivered_units": 39,
      "description": "Redeemable for a $10 gift card",
      "display": {
        "description_html": "<p>Use this gift card online or in store.</p>",
        "disclosure_html": "<p>Valid in the United States.</p>",
        "image_url": "https://images.example.com/gift-card.png",
        "instructions_html": "<p>Present the gift card at checkout.</p>"
      },
      "face_currency": "USD",
      "face_value": {
        "amount_minor": 2500,
        "currency": "USD"
      },
      "fulfillment": {
        "account_status": "ACTIVE",
        "asset_scale": 2,
        "countries": [
          "US"
        ],
        "currencies": [
          "USD"
        ],
        "delivery_method": "claim_link",
        "denominations": [
          {
            "amount_minor": 2500,
            "currency": "USD"
          }
        ],
        "rate": "1.5",
        "value_max": {
          "amount_minor": 2500,
          "currency": "USD"
        },
        "value_min": {
          "amount_minor": 2500,
          "currency": "USD"
        }
      },
      "fulfillment_product_id": "3f5b7d91-a2c4-4e68-8a0d-f1b3c5e7d927",
      "id": "2b7a9c4e-1f3d-4a8b-9e6c-5a1d3f7b8c08",
      "kind": "CUSTOM",
      "max_per_participant": 2,
      "max_total": 100,
      "name": "$10 Gift Card",
      "pending_units": 3,
      "program_id": "8f14e45f-ceea-4e70-9df8-2a7d1b3c9f01",
      "redemption_type": "UNIT_BASED",
      "reward_source_id": "9a0c2e4b-6d81-4f35-a7c9-1b3d5f7e9a14",
      "status": "ACTIVE",
      "unit_cost": "1000.00",
      "updated_at": "2027-01-15T10:30:00Z"
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "YWJjMTIz"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.