Automations

List automation runs

List automation runs of the company with cursor pagination, oldest first.

Filter by status, automation_rule_id or creation window; use ending_before to go backwards.
Needs the dedicated automation_runs:read scope, because runs embed the triggering event data.

get/companies/{company}/automations/runs

Request

Base URL: https://api.factuarea.com/v1
URL: https://api.factuarea.com/v1/companies/{company}/automations/runs
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).

Query parameters

automation_rule_idstring uuid

Automation rule ID (UUID v7) whose runs are listed.

subject_company_idstring uuid

Subject tax ID (UUID v7) the run acted upon. Only tax IDs of your portfolio yield results.

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.

Status of the run. dead_lettered and failed are the ones worth replaying; blocked means a guardrail stopped it before executing. Exact match on status.

created[gte]string date-time

Creation date (ISO 8601). Greater than or equal to the given value.

created[lte]string date-time

Creation date (ISO 8601). Less than or equal to the given value.

created[gt]string date-time

Creation date (ISO 8601). Strictly greater than the given value.

created[lt]string date-time

Creation date (ISO 8601). Strictly less than the given value.

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-3c5d6e7f8a63",
      "automation_rule_id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a61",
      "rule_version": 2,
      "rule_snapshot": {
        "name": "Avisar de un cobro grande",
        "trigger_type": "invoice.paid",
        "scope": "empresa",
        "conditions": {
          "field": "total",
          "operator": "gte",
          "value": 1000
        },
        "actions": [
          {
            "type": "notify_in_app",
            "order": 0,
            "parameters": {
              "recipient_type": "role",
              "role": "admin",
              "category": "invoice",
              "title": "Cobro grande",
              "message": "Se ha cobrado una factura de 1000 EUR o más."
            }
          }
        ]
      },
      "trigger_type": "invoice.paid",
      "event_name": "invoice.paid",
      "event_aggregate_id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a20",
      "event_occurred_on": "2026-03-16T11:05:00Z",
      "event_payload": {
        "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a20",
        "object": "invoice",
        "number": "FAC-2026-00042",
        "status": "paid",
        "total": "1250.00"
      },
      "correlation_id": "req_01HKQS5N7UR6PWJ8K2T5BWPMZ9",
      "status": "completed",
      "attempts": 1,
      "started_at": "2026-03-16T11:05:01Z",
      "finished_at": "2026-03-16T11:05:02Z",
      "created_at": "2026-03-16T11:05:00Z",
      "updated_at": "2026-03-16T11:05:02Z",
      "steps": [
        {
          "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a64",
          "object": "automation_step_run",
          "step_index": 0,
          "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"
          },
          "discard_reason": null,
          "discard_reason_label": null,
          "replayable": false,
          "last_error": null,
          "next_retry_at": null,
          "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.