Skip to main content
GET
Get an automation

Authorizations

Authorization
string
header
required

Bearer authentication using the project Secret Key (prefixed with sk_, or test_sk_ for sandbox). All v4 public endpoints require the Secret Key — see Authentication. Never expose the Secret Key in client-side code.

Path Parameters

automation_id
string
required

Automation identifier.

Maximum string length: 256
Pattern: ^[a-zA-Z0-9._-]+$

Response

Automation details.

object
enum<string>
required

Always "automation".

Available options:
automation
id
string
required

Unique automation identifier.

Example:

"auto-abc123"

url
string
required

Canonical API path for this automation.

Example:

"/v4/automations/auto-abc123"

name
string
required

Human-readable name of the automation.

Example:

"Welcome Flow"

caption
string
required

Optional description of the automation.

Example:

"Sends a welcome message to new users"

status
string
required

Lifecycle status of the automation. paused is set via PATCH /automations/{id}/status to temporarily stop an active automation without deleting it. unknown is returned as a forward-compatibility fallback and should not be written.

Example:

"active"

data
object
required

Automation configuration. Push and event resources are dashboard-only; this object references them by uid.