---
title: Workflow schema
description: Fields of the Workflow object in the Cascades API.
canonical_url: "https://cascades.crscreditapi.com/docs/api/schemas/Workflow"
doc_version: "1.0.0"
last_updated: "2026-10-09T18:04:24Z"
source: "public/api-docs/v1/swagger.yaml#/components/schemas/Workflow"
---

# Workflow

Defined in [openapi.json](https://cascades.crscreditapi.com/openapi.json#/components/schemas/Workflow) ([YAML](https://cascades.crscreditapi.com/openapi.yaml)).

| Field | Type | Required | Description |
|---|---|---|---|
| `id` | integer | yes |  |
| `object` | string | yes |  |
| `code` | string, nullable | no | Short human-readable code assigned by Cascades. |
| `name` | string | yes |  |
| `active` | boolean | yes | `true` = activated and triggerable in live mode. Drafts (`false`) can still be triggered in test mode. |
| `trigger_type` | string | yes |  One of: `"manual"`, `"event"`, `"scheduled"`. |
| `use_case` | string, nullable | no |  |
| `created_at` | string (date-time) | no |  |
| `updated_at` | string (date-time) | no |  |

```json
{
  "id": 27,
  "object": "workflow",
  "code": "TSS-27",
  "name": "Tenant Screening Standard",
  "active": true,
  "trigger_type": "manual",
  "use_case": "tenant_screening",
  "created_at": "2026-05-08T18:41:05Z",
  "updated_at": "2026-05-08T18:41:05Z"
}
```

## Sitemap

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