Automation2

get

Returns a filtered list of automations. When 'include_subfolders' is set to true, it returns a paginated list of automations in a specified folder and its subfolders.

Authorizations

businessId & userId & apiKey

X-BUSINESS-IDstringRequired

X-USER-IDstringRequired

X-API-KEYstringRequired

Query parameters

activebooleanOptional

custom_object_idstring · uuidOptional

custom_object_namestringOptional

folder_idstring · uuidOptional

Filters automations by folder_id. Will be set to root when include_subfolder is toggled on.

include_empty_foldersbooleanOptional

Displays folders without matching automations, by default they are hidden

Default: false

include_subfoldersbooleanOptional

Returns folder structure instead of a list. If folder_id query parameter is not set, root folder will be used by default.

Default: false

orderingstring · enumOptional

Which field to use when ordering the results. Prepend with '-' for descending order.

Possible values:

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

searchstringOptional

A search term.

Responses

200Success

application/json

get

/api/automation2/automations

HTTPcURLJavaScriptPython

GET /api/automation2/automations HTTP/1.1
Host: 
X-BUSINESS-ID: YOUR_API_KEY
X-USER-ID: YOUR_API_KEY
X-API-KEY: YOUR_API_KEY
Accept: */*

200Success

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "api_name": "text",
      "created": "2026-01-17T07:10:52.038Z",
      "active": true,
      "type": "record_based",
      "revision": 1,
      "number_active": 1,
      "number_paused": 1,
      "number_completed": 1,
      "custom_object": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "entity_name": "text",
        "object_name": "text",
        "object_class": "text",
        "object_type": "pipeline",
        "default_on_activities": true,
        "deleted": true
      },
      "folder": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text"
      },
      "created_by": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "display_name": "text"
      },
      "updated_by": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "display_name": "text"
      },
      "user_description": "text",
      "ai_description": "text"
    }
  ],
  "errors": [
    "error message"
  ]
}

post

Start automation

Authorizations

businessId & userId & apiKey

X-BUSINESS-IDstringRequired

X-USER-IDstringRequired

X-API-KEYstringRequired

Path parameters

automation_identifierstringRequired

Query parameters

orderingstring · enumOptional

Which field to use when ordering the results. Prepend with '-' for descending order.

Possible values:

Body

application/json

client_idstring · uuidOptional

record_idstring · uuidOptional

Responses

200Success

application/json

post

/api/automation2/automations/{automation_identifier}/start

HTTPcURLJavaScriptPython

POST /api/automation2/automations/{automation_identifier}/start HTTP/1.1
Host: 
X-BUSINESS-ID: YOUR_API_KEY
X-USER-ID: YOUR_API_KEY
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 103

{
  "client_id": "123e4567-e89b-12d3-a456-426614174000",
  "record_id": "123e4567-e89b-12d3-a456-426614174000"
}

200Success

{
  "execution": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "automation_id": "123e4567-e89b-12d3-a456-426614174000",
    "client_id": "123e4567-e89b-12d3-a456-426614174000",
    "record_id": "123e4567-e89b-12d3-a456-426614174000",
    "status": "text",
    "trigger_history_id": "123e4567-e89b-12d3-a456-426614174000",
    "debug_mode": "text"
  }
}