Skip to main content
GET
/
v1
/
programs
/
{id}
Get a program
curl --request GET \
  --url https://api.scrip.dev/v1/programs/{id} \
  --header 'X-API-Key: <api-key>'
{
  "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"
}

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 single program by its id. The response includes the program’s status, on_unknown_participant enrollment policy, and full configuration. Use this to verify a program is ACTIVE before submitting events, or to inspect its enrollment policy.
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.

Path Parameters

​
id
string<uuid>
required

Program ID

Response

Program details

​
created_at
string<date-time>

When the program was created

Example:

"2024-01-15T10:30:00Z"

​
deleted_at
string<date-time>

Set when the program is archived

​
description
string

Optional program description

Example:

"Quarterly sales incentive program"

​
id
string<uuid>

Program ID

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
name
string

Program name

Example:

"Q1 Sales Bonus"

​
on_unknown_participant
string

How events for unregistered participants are handled

Example:

"CREATE"

​
redemption_target_entity_id
string

Target ledger entity ID. Present only when redemption_target_type is LEDGER_ENTITY.

​
redemption_target_type
string

Where redeemed value is posted: SYSTEM_REDEMPTION, SYSTEM_BREAKAGE, or LEDGER_ENTITY

Example:

"SYSTEM_REDEMPTION"

​
status
string

Lifecycle state

Example:

"ACTIVE"

​
updated_at
string<date-time>

When the program was last modified

Example:

"2024-01-15T10:30:00Z"