Skip to main content
GET
List automation subscriptions
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 or one_time 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,
firing,
paused,
completed,
failed,
cancelled
limit
integer
default:50

Maximum number of results (default 50, max 200)

Required range: 1 <= x <= 200
cursor
string

Pagination cursor from a previous response

Response

Paginated subscriptions

data
object[]

Data contains the list of items

pagination
object

Pagination contains cursor information for fetching more results