Automations

List the steps of an automation run

List the steps of a run in execution order with cursor pagination.

  • Same step documents as the run detail, without the two heavy frozen snapshots; cheaper to poll.
  • step_index identifies a step: it is what you replay.
get/companies/{company}/automations/runs/{run}/steps

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/companies/{company}/automations/runs/{run}/steps
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

companystring uuid required

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

runstring uuid required

Public identifier (UUID v7) of the automation run.

Query parameters

limitinteger

Number of objects to return, between 1 and 100 (default 25).

starting_afterstring uuid

Cursor for forward pagination: pass the id of the last object on the previous page (the next_cursor of the previous response).

ending_beforestring uuid

Cursor for backward pagination: pass the id of the first object on the current page.

Headers

Factuarea-Versionstring date
Example:2026-06-01

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Response

has_moreboolean required

Whether more pages are available after this one.

next_cursorstring nullable required

Opaque cursor for the next page, or null when has_more is false. The example below shows the shape used by most listings; others return a different one, so pass the value back verbatim instead of validating it.

Example response

{
  "data": [
    {
      "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a64",
      "action_type": "notify_in_app",
      "status": "succeeded",
      "attempts": 1,
      "parameters": {
        "recipient_type": "role",
        "role": "admin",
        "category": "invoice",
        "title": "Cobro grande",
        "message": "Se ha cobrado una factura de 1000 EUR o más."
      },
      "result": {
        "recipient_type": "role",
        "recipient": "admin",
        "category": "invoice",
        "title": "Cobro grande",
        "priority": "normal"
      },
      "claimed_at": "2026-03-16T11:05:01Z",
      "finished_at": "2026-03-16T11:05:02Z"
    }
  ],
  "has_more": true,
  "next_cursor": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a0c"
}

Changes

No recorded changes to this operation across all 1 revision of this API.