RevKeenDocs
StatusSupport
API Reference

List runs for an automation

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.

GET
/automations/{id}/runs

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 for SDK auto-paging helpers.

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

Query Parameters

status?string

Filter runs by status (e.g. queued, running, succeeded, failed).

limit?number

Maximum number of runs to return (1-100, default 25).

Range1 <= value <= 100
Default25

Response Body

application/json

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" \
  -H "x-api-key: $REVKEEN_API_KEY"
{  "object": "list",  "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"    }  ]}

Retrieve a run GET

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 billing anchor rules GET

Get the list of supported billing anchor rules with explanations. --- **Related endpoints** - `POST /billing/preview` — Generate billing schedule preview - `GET /billing/intervals` — Get billing intervals **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.