Get request automation definitions | Atomicwork

curl -G https://{tenant}.atomicwork.com/api/v1/workspaces/1/request-automations/QUESTION_REQUEST \
     -H "X-Workspace-Id: {{workspace_id}}" \
     -H "X-Api-Key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d status=PUBLISHED \
     -d trigger_type=EVENT \
     -d sort_order=CREATED_AT_ASC

{
  "automations": [
    {
      "id": 1024,
      "name": "New Question Request Automation",
      "description": "Automation triggered when a new question request is created",
      "status": "PUBLISHED",
      "is_active": true,
      "trigger_type": "EVENT",
      "created_at": "2024-05-10T09:15:00Z",
      "updated_at": "2024-05-15T12:00:00Z",
      "actions": [
        {
          "type": "SEND_NOTIFICATION",
          "parameters": {
            "recipient": "support-team@acme.com",
            "message": "A new question request has been submitted."
          }
        }
      ]
    },
    {
      "id": 1025,
      "name": "Weekly Question Request Summary",
      "description": "Scheduled automation to send weekly summary of question requests",
      "status": "DRAFT",
      "is_active": false,
      "trigger_type": "SCHEDULED_RECURRING",
      "created_at": "2024-04-01T08:00:00Z",
      "updated_at": "2024-04-20T10:30:00Z",
      "actions": [
        {
          "type": "GENERATE_REPORT",
          "parameters": {
            "report_type": "weekly_summary",
            "format": "pdf"
          }
        }
      ]
    }
  ]
}

Authentication

X-Api-Keystring

API Key authentication via header

Path parameters

idlongRequired

Workspace ID (numeric). Find yours under Settings → Workspace.

typeenumRequired

Automation entity type (see allowed values in the enum schema).

Query parameters

statusenumOptional

Allowed values:

is_activebooleanOptional

search_keystringOptional>=1 character

trigger_typeenumOptional

Filter by trigger type (SCHEDULED_RECURRING or EVENT)

Allowed values:

sort_orderenumOptional

entity_idlongOptional

Deprecated alias of entity_type_id for typed entities (CUSTOM_OBJECT/ASSET). Retained for backward compatibility.

entity_type_idlongOptional

Filters automations by entity type ID (for CUSTOM_OBJECT type — the object type ID). Null for REQUEST/CHANGE.

Response

Successful response

Authentication

Path parameters

Headers

Query parameters

Response