Skip to main content
GET
List automations
Lists automations for a given program. Results are paginated and returned in reverse-chronological order. Use search to find automations by name. Without a status filter, the list excludes terminal statuses (completed, failed, archived); pass status explicitly to see them. Filter by trigger (the trigger.type), scope, status, and source. The source filter distinguishes automations created through the API (api), by a SCHEDULE_EVENT or BROADCAST rule action (rule_action), and by Scrip for tasks such as tier expiration (system). The default list returns api and rule_action rows only; pass source=system to see system rows. When you combine filters, results must match all of them.
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

Query Parameters

trigger
enum<string>

Filter by trigger.type

Available options:
cron,
one_time,
participant_state
scope
enum<string>

Filter by scope

Available options:
program,
participants
status
enum<string>

Filter by status

Available options:
active,
paused,
completed,
failed,
archived
source
enum<string>

Filter by source

Available options:
api,
rule_action,
system

Search by automation name (partial match)

limit
integer

Max results per page (1-200, default 50)

Required range: x >= 1
cursor
string

Pagination cursor from a previous response

Response

Paginated automations

data
object[]

Data contains the list of items

pagination
object

Pagination contains cursor information for fetching more results