Automations

Retrieve an automation run

Retrieve one run with its frozen definition version, the triggering event data.object and its steps in order.

The snapshots keep old runs readable after the rule changes.
A run of another company returns 404 automation_run_not_found.

get/companies/{company}/automations/runs/{run}

Request

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

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

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"
      }
    ]
  }
}

Changes

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