RevKeenDocs
StatusSupport
API Reference

Retrieve a run

Get the details of a specific automation run including its steps and outputs. --- **Related endpoints** - `GET /automations` — List automations - `POST /automations` — Create an automation - `GET /automations/{id}` — Retrieve an automation - `GET /automations/{id}/runs` — List runs for an automation - `POST /automations/{id}/runs` — Run an automation - `GET /automations/approvals` — List approvals - `POST /automations/approvals/{approvalId}/approve` — Approve an automation approval - `POST /automations/approvals/{approvalId}/reject` — Reject an automation approval **Common errors** - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.

GET
/automations/{id}/runs/{runId}

Get the details of a specific automation run including its steps and outputs.

Related endpoints

  • GET /automations — List automations
  • POST /automations — Create an automation
  • GET /automations/{id} — Retrieve an automation
  • GET /automations/{id}/runs — List runs for an automation
  • POST /automations/{id}/runs — Run an automation
  • GET /automations/approvals — List approvals
  • POST /automations/approvals/{approvalId}/approve — Approve an automation approval
  • POST /automations/approvals/{approvalId}/reject — Reject an automation approval

Common errors

  • 404 resource_missing — the referenced resource does not exist or is not visible to your key.

Authorization

x-api-key<token>

Your RevKeen merchant API key. Create and manage keys in Dashboard → Settings → Developer. Use rk_sandbox_* for staging/test and rk_live_* for production. The same key may be sent as Authorization: Bearer <key> if that suits your HTTP client better. A missing, invalid, expired, or revoked key returns 401 with a WWW-Authenticate: Bearer challenge; a valid key without the required scope returns 403.

In: header

Path Parameters

id*string

The automation ID

Formatuuid
runId*string

The run ID

Formatuuid

Response Body

application/json

application/json

application/json

application/json

Stuck on an error response? Ask the RevKeen assistant to explain it.
curl "https://api.revkeen.com/v2/automations/00000000-0000-0000-0000-000000000000/runs/00000000-0000-0000-0000-000000000000" \
  -H "x-api-key: $REVKEEN_API_KEY"
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "object": "automation_run",    "automation_id": "64fb5f73-6415-4f56-8e9e-ca06539f09ac",    "automation_name": "string",    "status": "string",    "trigger_source": "string",    "summary": "string",    "error_message": "string",    "created_at": "2019-08-24T14:15:22Z",    "started_at": "2019-08-24T14:15:22Z",    "completed_at": "2019-08-24T14:15:22Z",    "automation_version_id": "cda2ed79-119f-41c9-a9ef-36f4a9f69a6f",    "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84",    "trigger_payload": null,    "version": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "version": 0,      "objective": "string"    },    "automation": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "status": "string",      "trigger_type": "string",      "risk_profile": "string"    },    "steps": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "step_index": 0,        "step_type": "string",        "name": "string",        "status": "string",        "input_json": null,        "output_json": null,        "duration_ms": 0,        "created_at": "2019-08-24T14:15:22Z"      }    ],    "approvals": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "status": "string",        "action_summary": "string",        "actions_json": null,        "approved_by_user_id": "6f927876-90f9-4dae-8888-4b498595faf4",        "approved_at": "2019-08-24T14:15:22Z",        "rejection_reason": "string",        "created_at": "2019-08-24T14:15:22Z",        "updated_at": "2019-08-24T14:15:22Z"      }    ],    "notifications": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "type": "string",        "priority": "string",        "message": "string",        "payload_json": null,        "delivered_at": "2019-08-24T14:15:22Z",        "created_at": "2019-08-24T14:15:22Z"      }    ]  }}

Run an automation POST

Queue a manual run of a saved automation. --- **Related endpoints** - `GET /automations` — List automations - `POST /automations` — Create an automation - `GET /automations/{id}` — Retrieve an automation - `GET /automations/{id}/runs` — List runs for an automation - `GET /automations/{id}/runs/{runId}` — Retrieve a run - `GET /automations/approvals` — List approvals - `POST /automations/approvals/{approvalId}/approve` — Approve an automation approval - `POST /automations/approvals/{approvalId}/reject` — Reject an automation approval **Common errors** - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. **Idempotency** Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).

List runs for an automation GET

List execution runs for a saved automation, optionally filtered by status. --- **Related endpoints** - `GET /automations` — List automations - `POST /automations` — Create an automation - `GET /automations/{id}` — Retrieve an automation - `POST /automations/{id}/runs` — Run an automation - `GET /automations/{id}/runs/{runId}` — Retrieve a run - `GET /automations/approvals` — List approvals - `POST /automations/approvals/{approvalId}/approve` — Approve an automation approval - `POST /automations/approvals/{approvalId}/reject` — Reject an automation approval **Common errors** - `400 invalid_request` — malformed payload or failed validation. - `401 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. **Pagination** Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers.