Retrieve an Automation by UUID

Before You Begin

🔗 Use the GraphQL Playground to execute the queries in this guide.

➡️ New to GraphQL? Learn how to navigate the Playground with our Playground Basics Guide.

Prerequisites

1. Authentication: Use a Service Account token (Personal Access Tokens are deprecated).
2. Permissions: Ensure your token has permissions to view the automation.
3. Automation UUID: The UUID of the automation you want to retrieve. This value is emitted in card activity Kafka payloads as automation_uuid and is also available via the uuid field on the automation object.

Query

Use the automationByUuid query to fetch a single automation by its UUID:

{
  automationByUuid(uuid: "550e8400-e29b-41d4-a716-446655440000") {
    id
    uuid
    name
    active
    event_id
    action_id
  }
}

Response

{
  "data": {
    "automationByUuid": {
      "id": "42",
      "uuid": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Move card on creation",
      "active": true,
      "event_id": "card_created",
      "action_id": "move_card"
    }
  }
}

If no automation with the given UUID exists, or the caller does not have permission to view it, the query returns null:

{
  "data": {
    "automationByUuid": null
  }
}

Notes

• The uuid field is stable across pipe clones — each cloned automation receives a new UUID at clone time, so the UUID uniquely identifies a single automation definition.
• This query is useful when you receive an automation_uuid in a card activity event and need to fetch the current state of the automation that triggered the activity.