Skip to main content
GET
/
v1
/
programs
/
{programId}
/
rewards
List rewards
curl --request GET \
  --url https://api.scrip.dev/v1/programs/{programId}/rewards \
  --header 'X-API-Key: <api-key>'
import requests

url = "https://api.scrip.dev/v1/programs/{programId}/rewards"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.scrip.dev/v1/programs/{programId}/rewards', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.scrip.dev/v1/programs/{programId}/rewards",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.scrip.dev/v1/programs/{programId}/rewards"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("X-API-Key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.scrip.dev/v1/programs/{programId}/rewards")
.header("X-API-Key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.scrip.dev/v1/programs/{programId}/rewards")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "data": [
    {
      "asset_id": "550e8400-e29b-41d4-a716-446655440002",
      "available_from": "2024-01-01T00:00:00Z",
      "available_until": "2024-12-31T23:59:59Z",
      "category": "Gift Cards",
      "created_at": "2024-01-15T10:30:00Z",
      "description": "Redeemable for a $10 gift card",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "max_per_participant": 2,
      "max_total": 100,
      "metadata": {},
      "name": "$10 Gift Card",
      "program_id": "550e8400-e29b-41d4-a716-446655440001",
      "redeemed_count": 42,
      "redemption_type": "UNIT_BASED",
      "status": "ACTIVE",
      "unit_cost": "1000.00",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "YWJjMTIz"
  }
}
{
"code": "bad_request",
"details": {
"expected": "uuid",
"field": "asset_id",
"fields": [
{
"expected": "<unknown>",
"field": "amount",
"message": "This field is required",
"reason": "required",
"received": "-10.00"
}
],
"reason": "invalid",
"received": "not-a-uuid"
},
"message": "Invalid request parameters"
}
{
"code": "unauthorized",
"details": {
"expected": "uuid",
"field": "asset_id",
"fields": [
{
"expected": "<unknown>",
"field": "amount",
"message": "This field is required",
"reason": "required",
"received": "-10.00"
}
],
"reason": "invalid",
"received": "not-a-uuid"
},
"message": "Missing or invalid credentials"
}
{
"code": "internal_error",
"message": "An internal error occurred"
}
Returns all rewards in a program’s catalog. Archived rewards are excluded by default; pass include_archived=true to include them. Filter by status, use search to find rewards by name, and sort_by / sort_dir to control ordering.
For usage patterns and examples, see the Rewards Catalog guide.

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
include_archived
boolean
default:false

Include archived 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