Skip to main content
GET
/
v1
/
programs
List programs
curl --request GET \
  --url https://api.scrip.dev/v1/programs \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "created_at": "2024-01-15T10:30:00Z",
      "deleted_at": "2023-11-07T05:31:56Z",
      "description": "Quarterly sales incentive program",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Q1 Sales Bonus",
      "on_unknown_participant": "CREATE",
      "redemption_target_entity_id": "<string>",
      "redemption_target_type": "SYSTEM_REDEMPTION",
      "status": "ACTIVE",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "YWJjMTIz"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.scrip.dev/llms.txt

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

Returns a paginated list of all programs in your organization. Filter by status, use search to find programs by name, and sort_by / sort_dir to control ordering. Archived programs are excluded by default unless you filter by status or pass include_archived=true.
For usage patterns and examples, see the Programs guide.

Authorizations

​
X-API-Key
string
header
required

API key passed in the X-API-Key header.

Query Parameters

​
limit
integer
default:50

Maximum number of results (default 50, max 200)

Required range: x >= 1
​
cursor
string

Pagination cursor from previous response

​
include_archived
boolean
default:false

Include archived programs

​
status
enum<string>

Filter by program status

Available options:
ACTIVE,
SUSPENDED,
ARCHIVED
​
search
string

Search by program name (partial match)

​
sort_by
enum<string>

Sort field

Available options:
created_at,
name
​
sort_dir
enum<string>

Sort direction

Available options:
asc,
desc

Response

List of programs

​
data
object[]

Data contains the list of items

​
pagination
object

Pagination contains cursor information for fetching more results