Skip to content

List automation run rows

Platform module

GET/automation-runsautomationRuns.list

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 a cursor page of automation run rows the caller may see. The default order is `created_at` descending, newest first. Supports sparse fieldsets and the filter grammar.

  • Requires the capability org.automations.write.
  • OAuth scopes: org.
  • Cursor-paginated: limit, cursor, fields, sort and filter apply.
  • Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.

Path and query parameters

automationRuns.list: Path and query parameters
FieldTypeRequiredDescription
limitLimitNoPage size. Default 50, maximum 200.Constraints: range 1 to 200
cursorCursorNoOpaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any
fieldsFieldsNoSparse 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_]*)*$
sortSortNoSort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Constraints: pattern ^-?[a-z_][a-z0-9_]*(,-?[a-z_][a-z0-9_]*)*$
filterFilterNoFilter 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.

Response 200: a page of AutomationRun

automationRuns.list: AutomationRun
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the automation run.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row.
automation_idstring (uuid)YesIdentifier of the automation that ran.
domain_event_idstring (uuid)YesIdentifier of the domain event that started the run.
parent_run_idstring (uuid) | nullYesIdentifier of the run whose action raised the event, when an automation caused it.
depthintegerYesAutomation runs that led to this one; 0 for an event a person raised.Constraints: range 0 to any
run_status"Queued" | "Running" | "Retrying" | "Succeeded" | "Failed" | "Skipped"YesQueued, 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_payloadobjectYesThe event as webhooks send it: the run's input.
owner_person_idstring (uuid) | nullYesIdentifier of the person the run acted as.
attemptsintegerYesTimes the worker started the run.Constraints: range 0 to any
error_codestring | nullYesRule code of the failure or skip.Constraints: pattern ^[a-z][a-z0-9_]*$
error_messagestring | nullYesWhy the run failed or was skipped.Constraints: length 1 to 2000
started_atstring (date-time) | nullYesWhen the worker first started the run.
finished_atstring (date-time) | nullYesWhen the run reached Succeeded, Failed or Skipped.
duration_msinteger | nullYesMilliseconds from the first start to the end.Constraints: 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_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
    }
  ],
  "next_cursor": null
}

Code samples

curl -X GET "$XOS_BASE_URL/automation-runs" \
  -H "Authorization: Bearer $XOS_API_KEY"
for await (const row of xos.automationRuns.listAll()) {
  console.log(row);
}
for row in xos.automation_runs.list_all():
    print(row)
xos automation-runs list --all