Get an automation run step
Platform module
GET/automation-run-steps/{id}automationRunSteps.get
One action of an automation run: the public API operation called as the owner, what was sent and answered, and how long it took. A retried run rewrites the step of the action that failed. Returns one automation run step with its `ETag`. A automation run step the caller may not see returns 404.
- Requires the capability org.automations.write.
- OAuth scopes: org.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the automation run step. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Response 200: AutomationRunStep
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the automation run step. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row. |
| automation_run_id | string (uuid) | Yes | Identifier of the run the step belongs to. |
| automation_action_id | string (uuid) | null | Yes | Identifier of the action the step ran. |
| position | integer | Yes | Position of the action, 1 first.Constraints: range 1 to any |
| action_type | "create_task" | "update_status" | "assign" | "add_comment" | "notify" | "call_webhook" | Yes | What the action does. |
| operation_id | string | null | Yes | Public API operation called.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| step_status | "Succeeded" | "Failed" | "Skipped" | Yes | Outcome of the action. |
| request_body | object | null | Yes | Body sent, with templates filled in from the event. |
| response_body | object | null | Yes | Identifying fields of the answer, or the problem it reported. |
| http_status | integer | null | Yes | HTTP status the API answered.Constraints: range 100 to any |
| error_code | string | null | Yes | Rule code of the failure.Constraints: pattern ^[a-z][a-z0-9_]*$ |
| error_message | string | null | Yes | Why the step failed.Constraints: length 1 to 2000 |
| started_at | string (date-time) | Yes | When the step started. |
| finished_at | string (date-time) | Yes | When the step ended. |
| duration_ms | integer | Yes | Milliseconds the step took.Constraints: range 0 to any |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"automation_run_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"automation_action_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"position": 1,
"action_type": "create_task",
"operation_id": "records.create",
"step_status": "Succeeded",
"request_body": {
"title": "Review Call the venue"
},
"response_body": {
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
},
"http_status": 201,
"error_code": "record_title_grammar",
"error_message": "A Task title starts with an imperative verb.",
"started_at": "2026-10-08T14:30:00Z",
"finished_at": "2026-10-08T14:30:00Z",
"duration_ms": 120
}Code samples
curl -X GET "$XOS_BASE_URL/automation-run-steps/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.automationRunSteps.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.automation_run_steps.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos automation-run-steps get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f