Skip to main content
GET
List automations
Lists all automations for a given program. Results are paginated and returned in reverse-chronological order by default. Use search to find automations by name. Filter by trigger_type, scope, status, and source. The source filter distinguishes between automations created via the API (api) and those generated by rule actions (rule_action). Combining multiple filters narrows results with AND logic.
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_type
enum<string>

Filter by trigger type

Available options:
cron,
one_time,
participant_state,
immediate
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

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