Programs

List programs

List all programs for your organization.

get/v1/programs

Request

Base URL: https://api.scrip.dev
URL: https://api.scrip.dev/v1/programs
Auth: HTTP bearer

Query parameters

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.

include_archivedboolean

Include archived programs

status'ACTIVE' | 'SUSPENDED' | 'ARCHIVED'

Filter by program status

searchstring

Search by program name (partial match)

sort_by'created_at' | 'name'

Sort field

sort_dir'asc' | 'desc'

Sort direction

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 programs

Example response

{
  "data": [
    {
      "created_at": "2027-01-15T10:30:00Z",
      "deleted_at": "2027-01-15T10:30:00Z",
      "description": "Quarterly sales incentive program",
      "fulfillment_max_face_value_minor": 10000,
      "fulfillment_mode": "INSTANT",
      "fulfillment_participant_max_amount_minor": 25000,
      "fulfillment_participant_max_count": 3,
      "fulfillment_participant_window_seconds": 86400,
      "id": "8f14e45f-ceea-4e70-9df8-2a7d1b3c9f01",
      "name": "Acme Rewards",
      "on_unknown_participant": "CREATE",
      "pending_redemption_ttl": "24h",
      "redemption_target_entity_id": "5e7a9c13-2d4f-4b68-9a0c-e1b3d5f7a920",
      "redemption_target_type": "SYSTEM_REDEMPTION",
      "status": "ACTIVE",
      "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.