Get Chat Workflow

Where a chat is in its workflow (lifecycle stages): current (the latest stage entered, with the workflow it belongs to and whether the run is live or finished), availableTransitions (the stages it may move to next — pass one as stageId to PUT …/workflow), activeWorkflows (every workflow with a live run on this chat; normally zero or one) and history (the last 100 stages entered, newest first, with who moved it, when it was left and the note).

Workflow and stage ids come from GET /workflows/{organisationId}. Pure read.

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).

string
required

The chat UUID (the chatId from the chat list / create-chat response).

Responses

401

Unauthorized

403

Forbidden

404

Chat not found in your organisation (code: CHAT_NOT_FOUND)

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