Skip to main content
GET
/
v1
/
programs
/
{programId}
/
automations
List automations
curl --request GET \
  --url https://api.scrip.dev/v1/programs/{programId}/automations \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "cron_expression": "<string>",
      "description": "<string>",
      "error_message": "<string>",
      "event_name": "<string>",
      "execution_completed_at": "2023-11-07T05:31:56Z",
      "execution_error": "<string>",
      "execution_started_at": "2023-11-07T05:31:56Z",
      "execution_status": "<string>",
      "filter_hints": [
        {}
      ],
      "guard_condition": "<string>",
      "id": "<string>",
      "last_error": "<string>",
      "last_evaluated_at": "2023-11-07T05:31:56Z",
      "last_run_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "next_run_at": "2023-11-07T05:31:56Z",
      "participant_filter": "<string>",
      "participant_id": "<string>",
      "participants_processed": 123,
      "participants_total": 123,
      "payload": {},
      "processed_at": "2023-11-07T05:31:56Z",
      "program_id": "<string>",
      "schedule_config": {},
      "schedule_type": "<string>",
      "scope": "<string>",
      "source": "<string>",
      "status": "<string>",
      "timezone": "<string>",
      "trigger_at": "2023-11-07T05:31:56Z",
      "trigger_type": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "YWJjMTIz"
  }
}
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
string

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