List Call Flows
Retrieve every call flow in the workspace, including archived ones.
Headers
x-workspace-idstringrequiredWorkspace identifier for the API.
The response is a plain array with one full call flow document per item, the same document Get Call Flow returns (settings, prompt versions and so on). There is no pagination or filtering.
Archived call flows are included. An archived flow has a non-null archivedAt; filter on it if you only want flows that can take calls.
Response Fields
_idstringThe unique identifier for the call flow.
workspaceIdstringThe identifier of the workspace where the call flow is configured.
namestringThe name assigned to the call flow.
directionstringoutbound or bidirectional (answers inbound calls and can place outbound ones).
agentobjectThe agent the flow uses, as a full agent object (_id, name, ttsModel, llmModel, sttProvider, phoneNumberIds and so on), with its phoneNumberIds populated as phone number objects. Use agent._id for the agent's ID. It is null if the flow has no agent.
folderIdobjectThe folder the flow is in, as { _id, name, icon, color }, or null.
isActivebooleanWhether the call flow is active.
archivedAtstringWhen the flow was archived, or null if it is not archived. Archived flows are read-only and do not take calls.
promptTypestringsimple (one prompt drives the call), nodes (a node-based flow) or flow (legacy).
settingsobjectThe flow's settings. See Update Call Flow.
createdAtstringTimestamp when the call flow was created.
updatedAtstringTimestamp when the call flow was last updated.
In the example, the agent objects and settings are shortened.
[
{
"_id": "c2c2c2c2c2c2c2c2c2c2c2c2",
"workspaceId": "c1c1c1c1c1c1c1c1c1c1c1c1",
"name": "Customer Support Flow",
"direction": "bidirectional",
"agent": {
"_id": "c3c3c3c3c3c3c3c3c3c3c3c3",
"name": "Customer Support Flow",
"phoneNumberIds": []
},
"folderId": null,
"isActive": true,
"archivedAt": null,
"promptType": "simple",
"settings": {},
"createdAt": "2025-01-02T09:00:00.000Z",
"updatedAt": "2025-01-02T09:30:00.000Z"
},
{
"_id": "c5c5c5c5c5c5c5c5c5c5c5c5",
"workspaceId": "c1c1c1c1c1c1c1c1c1c1c1c1",
"name": "Old Sales Flow",
"direction": "outbound",
"agent": {
"_id": "c6c6c6c6c6c6c6c6c6c6c6c6",
"name": "Old Sales Flow",
"phoneNumberIds": []
},
"folderId": {
"_id": "c7c7c7c7c7c7c7c7c7c7c7c7",
"name": "Sales",
"icon": "folder",
"color": "#3B82F6"
},
"isActive": true,
"archivedAt": "2025-03-01T10:00:00.000Z",
"promptType": "simple",
"settings": {},
"createdAt": "2025-01-05T09:00:00.000Z",
"updatedAt": "2025-03-01T10:00:00.000Z"
}
]Last updated on