Get an automation run

Módulo Platform

GET/automation-runs/{id}automationRuns.get

One run of an automation for one domain event (ADR 0047): an event never runs an automation twice. A run caused by another automation's action is one level deeper; past depth 3 it is Skipped (loop_depth), and past 1,000 runs in an hour in the org new runs are Skipped (rate_limited). A run fails closed when the owner left the org or lost org.automations.write, and the automation pauses with a notice. Returns one automation run with its `ETag`. A automation run the caller may not see returns 404.

Requiere la capacidad org.automations.write.
Alcances de OAuth: org.
Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

automationRuns.get: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the automation run.
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_])*$

Respuesta 200: AutomationRun

automationRuns.get: AutomationRun
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the automation run.
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_id	string (uuid)	Sí	Identifier of the automation that ran.
domain_event_id	string (uuid)	Sí	Identifier of the domain event that started the run.
parent_run_id	string (uuid) \| null	Sí	Identifier of the run whose action raised the event, when an automation caused it.
depth	integer	Sí	Automation runs that led to this one; 0 for an event a person raised.Restricciones: range 0 to any
run_status	"Queued" \| "Running" \| "Retrying" \| "Succeeded" \| "Failed" \| "Skipped"	Sí	Queued, Running, Retrying after a failure the job queue retries with backoff, Succeeded, Failed, or Skipped (loop_depth, rate_limited, or the automation was off).
event_payload	object	Sí	The event as webhooks send it: the run's input.
owner_person_id	string (uuid) \| null	Sí	Identifier of the person the run acted as.
attempts	integer	Sí	Times the worker started the run.Restricciones: range 0 to any
error_code	string \| null	Sí	Rule code of the failure or skip.Restricciones: pattern ^[a-z][a-z0-9_]*$
error_message	string \| null	Sí	Why the run failed or was skipped.Restricciones: length 1 to 2000
started_at	string (date-time) \| null	Sí	When the worker first started the run.
finished_at	string (date-time) \| null	Sí	When the run reached Succeeded, Failed or Skipped.
duration_ms	integer \| null	Sí	Milliseconds from the first start to the end.Restricciones: 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_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "domain_event_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "parent_run_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "depth": 0,
  "run_status": "Queued",
  "event_payload": {
    "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "type": "record.created",
    "occurred_at": "2026-10-08T14:30:00Z",
    "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "subject": {
      "table": "records",
      "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
    },
    "data": {
      "record_kind": "Task",
      "title": "Call the venue"
    }
  },
  "owner_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "attempts": 1,
  "error_code": "owner_left_org",
  "error_message": "The API answered 503.",
  "started_at": "2026-10-08T14:30:00Z",
  "finished_at": "2026-10-08T14:30:00Z",
  "duration_ms": 840
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/automation-runs/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"

const { data, etag } = await xos.automationRuns.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");

response = xos.automation_runs.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")

xos automation-runs get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f