List Workflows

Your organisation's workflows (lifecycle-stage sets), most recently updated first. Each carries its stages (id, name, type — initial, intermediate or final), the allowed transitions between them, and its closingRules (whether a disposition is required before a final stage, and whether finishing resolves the chat).

Use workflowId and the stage ids with PUT /chats/{organisationId}/{chatId}/workflow and with the workflowIds/stageIds filters on GET /chats/{organisationId}. Workflows are designed in the app (Settings → Workflow Lifecycle Stages); this endpoint is read-only. includeInactive=true also returns retired workflows, which cannot be attached but may still appear on older chats.

Requires CRM_ADMIN, ACCOUNT_OWNER, or CRM_BOT.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Your organisation UUID (returned as org from the /token endpoint).

Query Params
boolean

Include inactive (retired) workflows. Default false = active workflows only, i.e. the ones a chat can be attached to.

Responses

401

Unauthorized — invalid/expired token or wrong organisation

403

Forbidden — role not permitted

429

Too many requests

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json