Skip to main content
GET
/
v1
/
programs
/
{programId}
/
automations
/
{automationId}
/
subscriptions
List automation subscriptions
curl --request GET \
  --url https://api.scrip.dev/v1/programs/{programId}/automations/{automationId}/subscriptions \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "automation_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "last_error": "<string>",
      "last_triggered_at": "2023-11-07T05:31:56Z",
      "next_trigger_at": "2023-11-07T05:31:56Z",
      "participant_id": "<string>",
      "retry_count": 123,
      "status": "<string>",
      "trigger_count": 123
    }
  ],
  "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.

Lists the per-participant subscriptions for a participant_state automation. Each subscription shows the participant, next_trigger_at, and current status. Results are paginated. This endpoint only applies to automations with trigger.type set to participant_state. Calling it on a cron, one_time, or immediate automation returns an empty list. Use this to inspect which participants are currently enrolled and when their next event will fire.
For usage patterns and examples, see the Automations 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

​
automationId
string<uuid>
required

Automation ID

Query Parameters

​
status
enum<string>

Filter by subscription status

Available options:
active,
completed,
failed

Response

Paginated subscriptions

​
data
object[]

Data contains the list of items

​
pagination
object

Pagination contains cursor information for fetching more results