---
title: API reference
description: "Every Cascades REST endpoint, generated from the OpenAPI spec: workflows, executions, batches, webhooks."
canonical_url: "https://cascades.crscreditapi.com/docs/api"
doc_version: "1.0.0"
last_updated: "2026-10-09T18:04:24Z"
---

# Cascades API reference

Base URL: `https://cascades.crscreditapi.com/api/v1`. OpenAPI: https://cascades.crscreditapi.com/openapi.json · https://cascades.crscreditapi.com/openapi.yaml

## Workflows

- `GET /workflows` — [List workflows](https://cascades.crscreditapi.com/docs/api/workflows/list-workflows.md)
- `POST /workflows` — [Create a workflow](https://cascades.crscreditapi.com/docs/api/workflows/create-workflow.md)
- `POST /workflows/generate` — [Generate a workflow from a prompt](https://cascades.crscreditapi.com/docs/api/workflows/generate-workflow.md)
- `GET /workflows/{id}` — [Show a workflow](https://cascades.crscreditapi.com/docs/api/workflows/get-workflow.md)
- `PATCH /workflows/{id}` — [Update a workflow](https://cascades.crscreditapi.com/docs/api/workflows/update-workflow.md)
- `DELETE /workflows/{id}` — [Delete a workflow](https://cascades.crscreditapi.com/docs/api/workflows/delete-workflow.md)
- `GET /workflows/{id}/test_cases` — [List sandbox test cases for a workflow](https://cascades.crscreditapi.com/docs/api/workflows/list-workflow-test-cases.md)
- `POST /workflows/{id}/trigger` — [Trigger a workflow](https://cascades.crscreditapi.com/docs/api/workflows/trigger-workflow.md)

## Workflow templates

- `GET /workflow_templates` — [List published templates](https://cascades.crscreditapi.com/docs/api/workflow-templates/list-workflow-templates.md)
- `GET /workflow_templates/{id}` — [Show a template (with definition)](https://cascades.crscreditapi.com/docs/api/workflow-templates/get-workflow-template.md)

## Executions

- `GET /executions` — [List executions](https://cascades.crscreditapi.com/docs/api/executions/list-executions.md)
- `GET /executions/{id}` — [Show an execution](https://cascades.crscreditapi.com/docs/api/executions/get-execution.md)
- `POST /executions/{id}/cancel` — [Cancel an execution](https://cascades.crscreditapi.com/docs/api/executions/cancel-execution.md)
- `POST /executions/{id}/re_evaluations` — [Re-evaluate an execution](https://cascades.crscreditapi.com/docs/api/executions/re-evaluate-execution.md)
- `POST /executions/{id}/review_decisions` — [Approve or deny a paused review](https://cascades.crscreditapi.com/docs/api/executions/submit-review-decision.md)
- `GET /executions/{id}/review_events` — [List review audit events](https://cascades.crscreditapi.com/docs/api/executions/list-review-events.md)
- `POST /executions/{id}/review_assignment` — [Claim or unassign a review](https://cascades.crscreditapi.com/docs/api/executions/assign-review.md)
- `POST /executions/{id}/review_notes` — [Append a review note](https://cascades.crscreditapi.com/docs/api/executions/add-review-note.md)
- `POST /executions/review_bulk_actions` — [Bulk approve / deny / assign_to_me](https://cascades.crscreditapi.com/docs/api/executions/bulk-review-actions.md)
- `GET /executions/{id}/report_artifacts` — [List credit-report PDFs for an execution](https://cascades.crscreditapi.com/docs/api/executions/list-report-artifacts.md)
- `GET /executions/{id}/report_artifacts/{artifact_id}` — [Download a credit-report PDF](https://cascades.crscreditapi.com/docs/api/executions/get-report-artifact.md)
- `GET /executions/{id}/notice_artifacts` — [List adverse-action notice PDFs for an execution](https://cascades.crscreditapi.com/docs/api/executions/list-notice-artifacts.md)
- `GET /executions/{id}/notice_artifacts/{artifact_id}` — [Download an adverse-action notice PDF](https://cascades.crscreditapi.com/docs/api/executions/get-notice-artifact.md)

## Batches

- `POST /workflows/{id}/batches` — [Create a batch from N rows](https://cascades.crscreditapi.com/docs/api/batches/create-batch.md)
- `GET /batches` — [List batches](https://cascades.crscreditapi.com/docs/api/batches/list-batches.md)
- `GET /batches/{id}` — [Show a batch](https://cascades.crscreditapi.com/docs/api/batches/get-batch.md)
- `GET /batches/{id}/executions` — [List child executions of a batch](https://cascades.crscreditapi.com/docs/api/batches/list-batch-executions.md)
- `POST /batches/{id}/cancel` — [Cancel a batch](https://cascades.crscreditapi.com/docs/api/batches/cancel-batch.md)
- `POST /batches/{id}/resume` — [Resume an interrupted batch](https://cascades.crscreditapi.com/docs/api/batches/resume-batch.md)
- `POST /batches/{id}/retry_failed` — [Retry failed and skipped rows](https://cascades.crscreditapi.com/docs/api/batches/retry-failed-batch.md)
- `GET /batches/{id}/exports.csv` — [Download flat results CSV](https://cascades.crscreditapi.com/docs/api/batches/export-batch.md)
- `GET /batches/{id}/exports.zip` — [Download structured ZIP of batch results](https://cascades.crscreditapi.com/docs/api/batches/export-batch-zip.md)
- `GET /batches/{id}/adverse_action_notices.zip` — [Download all adverse-action notice PDFs as a ZIP](https://cascades.crscreditapi.com/docs/api/batches/download-batch-adverse-action-notices.md)

## Webhooks

- `GET /webhook_subscriptions` — [List webhook subscriptions](https://cascades.crscreditapi.com/docs/api/webhooks/list-webhook-subscriptions.md)
- `POST /webhook_subscriptions` — [Create a webhook subscription](https://cascades.crscreditapi.com/docs/api/webhooks/create-webhook-subscription.md)
- `GET /webhook_subscriptions/{id}` — [Show a webhook subscription](https://cascades.crscreditapi.com/docs/api/webhooks/get-webhook-subscription.md)
- `PATCH /webhook_subscriptions/{id}` — [Update a webhook subscription](https://cascades.crscreditapi.com/docs/api/webhooks/update-webhook-subscription.md)
- `DELETE /webhook_subscriptions/{id}` — [Delete a webhook subscription](https://cascades.crscreditapi.com/docs/api/webhooks/delete-webhook-subscription.md)
- `POST /webhook_subscriptions/{id}/rotate_secret` — [Rotate the signing secret](https://cascades.crscreditapi.com/docs/api/webhooks/rotate-webhook-secret.md)
- `GET /webhook_deliveries` — [List webhook deliveries](https://cascades.crscreditapi.com/docs/api/webhooks/list-webhook-deliveries.md)
- `GET /webhook_deliveries/{id}` — [Show a webhook delivery](https://cascades.crscreditapi.com/docs/api/webhooks/get-webhook-delivery.md)
- `POST /webhook_deliveries/{id}/retry` — [Manually retry a failed or dead delivery](https://cascades.crscreditapi.com/docs/api/webhooks/retry-webhook-delivery.md)

## Sitemap

See the full [sitemap](https://cascades.crscreditapi.com/sitemap.md) for all pages.