List automation run step rows
Módulo Platform
GET/automation-run-stepsautomationRunSteps.list
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 a cursor page of automation run step rows the caller may see. The default order is `automation_run_id`, then `position` ascending. Supports sparse fieldsets and the filter grammar.
- Requiere la capacidad org.automations.write.
- Alcances de OAuth: org.
- Paginación por cursor: se aplican limit, cursor, fields, sort y filter.
- Estados de error: 400, 401, 429. Los errores son detalles de problema RFC 9457.
Parámetros de ruta y de consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| limit | Limit | No | Page size. Default 50, maximum 200.Restricciones: range 1 to 200 |
| cursor | Cursor | No | Opaque cursor from `next_cursor` of the previous page.Restricciones: length 1 to any |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
| sort | Sort | No | Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Restricciones: pattern ^-?[a-z_][a-z0-9_]*(,-?[a-z_][a-z0-9_]*)*$ |
| filter | Filter | No | Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND. |
Respuesta 200: una página de AutomationRunStep
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the automation run step. |
| org_id | string (uuid) | Sí | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Sí | When the row was created. |
| created_by | string (uuid) | null | Sí | Identifier of the person who created the row. |
| updated_at | string (date-time) | Sí | When the row was last updated. |
| updated_by | string (uuid) | null | Sí | Identifier of the person who last updated the row. |
| automation_run_id | string (uuid) | Sí | Identifier of the run the step belongs to. |
| automation_action_id | string (uuid) | null | Sí | Identifier of the action the step ran. |
| position | integer | Sí | Position of the action, 1 first.Restricciones: range 1 to any |
| action_type | "create_task" | "update_status" | "assign" | "add_comment" | "notify" | "call_webhook" | Sí | What the action does. |
| operation_id | string | null | Sí | Public API operation called.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| step_status | "Succeeded" | "Failed" | "Skipped" | Sí | Outcome of the action. |
| request_body | object | null | Sí | Body sent, with templates filled in from the event. |
| response_body | object | null | Sí | Identifying fields of the answer, or the problem it reported. |
| http_status | integer | null | Sí | HTTP status the API answered.Restricciones: range 100 to any |
| error_code | string | null | Sí | Rule code of the failure.Restricciones: pattern ^[a-z][a-z0-9_]*$ |
| error_message | string | null | Sí | Why the step failed.Restricciones: length 1 to 2000 |
| started_at | string (date-time) | Sí | When the step started. |
| finished_at | string (date-time) | Sí | When the step ended. |
| duration_ms | integer | Sí | Milliseconds the step took.Restricciones: range 0 to any |
{
"data": [
{
"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
}
],
"next_cursor": null
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/automation-run-steps" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.automationRunSteps.listAll()) {
console.log(row);
}for row in xos.automation_run_steps.list_all():
print(row)xos automation-run-steps list --all