Sign in to run requests with your own sandbox key. Sign in

List executions

GET /api/v1/executions
executions:read

Executions started by the calling api_client, newest first. CSV filters (status, review_status) accept several comma-separated values; an unknown value returns 422. Requires executions:read.

Query parameters

NameTypeDescription
page integer

1-based page number.

Example: 1
per_page integer

Items per page. Values above 100 are clamped to 100.

Example: 25
filter[workflow_id] integer
filter[status] string

CSV of queued, pending, running, waiting, awaiting_review, completed, failed, cancelled, skipped

Example: completed,failed
filter[needs_human_review] boolean
filter[review_status] string

CSV of none, in_review, approved, denied

filter[batch_execution_id] integer
filter[execution_key] string

Exact match on the namespaced idempotency key.

filter[external_reference] string

Responses

  • 200 Execution list application/json
    • data array of Execution
      • id integer required
      • object string required
      • workflow_id integer required
      • status string required Lifecycle of an execution. `queued` (batch rows not yet dispatched), `pending`, `running` and `waiting` (paused on a Wait node or adverse-action waiting period) are in flight; `awaiting_review` is paused on human review; `completed`, `failed`, `cancelled` and `skipped` are terminal. One of queued pending running waiting awaiting_review completed failed cancelled skipped
      • execution_key string, nullable
      • external_reference string, nullable
      • needs_human_review boolean required
      • review_status string required One of none in_review approved denied
      • assigned_to_user_id integer, nullable The reviewer who claimed this execution, if any.
      • started_at string (date-time), nullable
      • completed_at string (date-time), nullable
      • created_at string (date-time) required
      • updated_at string (date-time), nullable
    • meta Meta

      Schema: PaginatedMeta

      • request_id string required Correlation id for this request. Also sent as the `X-Request-Id` response header; quote it when contacting support.
      • page integer required
      • per_page integer required
      • total_count integer required
      • total_pages integer required
      • object string required The object type of every item in `data`.
    200 example
    {
      "data": [
        {
          "id": 1842,
          "object": "execution",
          "workflow_id": 27,
          "status": "queued",
          "execution_key": "api_client:12:3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "external_reference": "rv-app-20491",
          "needs_human_review": true,
          "review_status": "none",
          "assigned_to_user_id": 1,
          "started_at": "2026-05-08T18:41:05Z",
          "completed_at": "2026-05-08T18:41:05Z",
          "created_at": "2026-05-08T18:41:05Z",
          "updated_at": "2026-05-08T18:41:05Z"
        }
      ],
      "meta": {
        "request_id": "7d4c2f48-9a1b-4c3d-8e2f-1a2b3c4d5e6f",
        "page": 1,
        "per_page": 25,
        "total_count": 142,
        "total_pages": 6,
        "object": "execution"
      }
    }
  • 401 Missing, malformed, expired or revoked bearer token. The WWW-Authenticate header carries the RFC 6750 challenge. application/json

    Schema: ErrorEnvelope

    401 example
    {
      "error": {
        "code": "unauthorized",
        "message": "A valid bearer token is required.",
        "details": [],
        "request_id": "7d4c2f48-9a1b-4c3d-8e2f-1a2b3c4d5e6f",
        "doc_url": "https://cascades.crscreditapi.com/docs/api/errors/unauthorized"
      }
    }
  • 403 Token does not hold the required scope. details lists the scope(s) that were checked. application/json

    Schema: ErrorEnvelope

    403 example
    {
      "error": {
        "code": "insufficient_scope",
        "message": "This token does not have the required scope.",
        "details": [
          {
            "field": "scope",
            "message": "executions:write"
          }
        ],
        "request_id": "7d4c2f48-9a1b-4c3d-8e2f-1a2b3c4d5e6f",
        "doc_url": "https://cascades.crscreditapi.com/docs/api/errors/insufficient_scope"
      }
    }
  • 422 Request body or params failed validation application/json

    Schema: ErrorEnvelope

    422 example
    {
      "error": {
        "code": "validation_failed",
        "message": "The request could not be processed.",
        "details": [
          {
            "field": "execution_mode",
            "message": "must be test or live"
          }
        ],
        "request_id": "7d4c2f48-9a1b-4c3d-8e2f-1a2b3c4d5e6f",
        "doc_url": "https://cascades.crscreditapi.com/docs/api/errors/validation_failed"
      }
    }
  • 429 Rate limit exceeded (60 req/min per IP on /api/v1, 600 req/hour per token prefix, or 300 req/5 min per IP globally). The body is the standard error envelope and Retry-After gives the seconds until the window resets. application/json

    Schema: ErrorEnvelope

    429 example
    {
      "error": {
        "code": "rate_limited",
        "message": "Rate limit exceeded. Retry later.",
        "details": [],
        "request_id": "7d4c2f48-9a1b-4c3d-8e2f-1a2b3c4d5e6f",
        "doc_url": "https://cascades.crscreditapi.com/docs/api/errors/rate_limited"
      }
    }
Was this page helpful?