Get automation

Get a single automation, including its full definition

Updated 27 July 2026

On this page

This endpoint returns a single automation you own, including its full definition (the trigger and its chained steps) so you can inspect or repair it.

Path Parameters

idstringrequired

The ID of the automation (from List automations)

Query Parameters

include_secretsboolean

By default, credential-bearing values inside the definition (API keys, tokens, Authorization headers) are masked as ••• hidden. Pass true to return them unmasked.

Response

dataobject

The automation

idstring

  The unique ID of the automation

namestring

  The display name of the automation

statusstring

  `enabled` or `disabled`

updated_atstring

  When the automation was last updated

definitionobject

  The automation's definition: the trigger object with its steps chained under `nextAction`. This is the artifact you edit and send back through [Update automation](/api-reference/automations/update-automation) to repair or extend the automation. See [Create automation](/api-reference/automations/create-automation) for the definition format.

bindingobject | null

  When the automation is attached to an assistant event: `{type, assistant_id, assistant_name}` (see [List automations](/api-reference/automations/list-automations)). Otherwise `null`.

A missing automation — or one that does not belong to your account — returns a 404 with {"message": "Automation not found"}.

{
  "data": {
    "id": "f4EaLhOW2zoEsXXSOJP2r",
    "name": "Order lookup",
    "status": "enabled",
    "updated_at": "2026-07-24T18:23:57.259Z",
    "definition": {
      "name": "trigger",
      "type": "PIECE_TRIGGER",
      "displayName": "Catch Webhook",
      "settings": {
        "pieceName": "@activepieces/piece-webhook",
        "triggerName": "catch_webhook"
      },
      "nextAction": {
        "name": "step_1",
        "type": "PIECE",
        "displayName": "Look up the order",
        "settings": {
          "pieceName": "@activepieces/piece-http",
          "actionName": "send_request",
          "input": {
            "url": "https://api.example.com/orders",
            "method": "GET",
            "headers": {
              "Authorization": "••• hidden"
            }
          }
        }
      }
    },
    "binding": null
  }
}