Automations
GET
Get Automation
GET /v1/automations/{automationId}Retrieve a specific automation by ID with full details.
Use Cases:
- View automation configuration and workflow definition
- Check automation status before publishing
- Retrieve trigger configuration and node details
- Display automation details in your application
- Review automation before making changes
Behavior:
- Returns complete automation object with all fields
- Includes trigger configuration, nodes, and edges
- Shows current status and version information
- Includes statistics if the automation has been published
- Automation must belong to your workspace
Required Scope: read:automations
Response Includes:
- Automation ID, name, description, and status
- Trigger type and configuration
- Workflow nodes (actions, conditions, delays)
- Workflow edges (connections between nodes)
- Version number and parent ID
- Statistics (if available)
- Publication and creation timestamps
Path parameters
automationIdstringrequiredAutomation ID
Response
200Successfully retrieved automation with full workflow definition
objectstringrequiredidstringrequirednamestringrequireddescriptionanyrequiredstatus"DRAFT" | "PUBLISHED" | "ARCHIVED"requiredversionnumberrequiredparentIdanyrequiredtriggerobjectrequirednodesany[]requirededgesany[]requiredstatsanyrequiredpublishedAtanyrequiredcreatedAtstringrequiredupdatedAtstringrequired