Get Call Flow
Retrieve a specific call flow by its ID.
Headers
x-workspace-idstringrequiredWorkspace identifier for the API.
Path Parameters
idstringrequiredThe unique ID of the call flow.
If the flow has unpublished changes from the call flow editor (an active draft), the response is that draft merged over the live flow, for every setting, not only the greeting. Calls received on the flow's number keep using the live version until the draft is published.
Errors
| Status | Body | When |
|---|---|---|
400 | {"error": "Workspace ID is required."} | No x-workspace-id |
500 | {"message": "Error fetching flow"} | Unexpected server error |
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).
descriptionstringA brief description of what the call flow is designed to handle.
agentobjectThe agent the flow uses, as a full agent object (_id, name, ttsModel, llmModel, sttProvider, phoneNumberIds and so on). 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.
archivedAtstringWhen the flow was archived, or null. An archived flow is read-only: Update Call Flow returns 409 until it is restored in the dashboard.
promptTypestringsimple (one prompt drives the call), nodes (a node-based flow) or flow (legacy).
flowDataobjectContains the configuration of nodes and edges defining the call routing logic.
nodesarrayAn array detailing each node in the call flow.
edgesarrayAn array detailing the edges connecting the nodes.
promptstringThe initial or system prompt that is presented in the call flow.
isActivebooleanIndicates whether the call flow is currently active.
settingsobjectThe configuration settings for the call flow, including knowledge bases, security and call settings. Update Call Flow describes each one.
knowledgeBasesarrayAn array of references to knowledge bases included in the call flow.
securityobjectSecurity settings relevant to the call flow.
hipaaCompliancebooleanIndicates whether HIPAA compliance is enabled.
callSettingobjectCall length and silence handling.
maxCallDurationnumberThe longest a call can last, in seconds.
endCallOnSilencenumberCheck in after: seconds of caller silence before the agent checks in to ask if anyone is there. Whole seconds, 5 to 30. It does not end the call by itself; see silenceReminderRetries and endCallAfterReminder on Update Call Flow.
welcomeMessageConfigobjectHow the agent opens a call: an Inbound and an Outbound greeting, each with selected, customMessage, aiGreetingPrompt, userFirstFallbackDelaySeconds and userFirstFallbackMessage. Some flows can be missing a direction, a field, or the whole object; a missing selected means aiFirst. Update Call Flow explains each field and how to change it.
Some older flows also return welcomeMessage and customWelcomeMessage, at the top level or inside settings. Nothing reads them; the greeting is welcomeMessageConfig.
If the flow has unpublished changes from the call flow editor, this shows that draft's greeting instead of the live one.
InboundobjectThe greeting for calls received on the flow's phone number.
OutboundobjectThe greeting for calls the flow places and for web calls made with the Web SDK.
createdAtstringTimestamp when the call flow was created.
updatedAtstringTimestamp when the call flow was last updated.
{
"_id": "c2c2c2c2c2c2c2c2c2c2c2c2",
"workspaceId": "c1c1c1c1c1c1c1c1c1c1c1c1",
"name": "Customer Support Flow",
"direction": "bidirectional",
"description": "Handles inbound support calls",
"agent": {
"_id": "c3c3c3c3c3c3c3c3c3c3c3c3",
"name": "Customer Support Flow",
"phoneNumberIds": []
},
"folderId": null,
"archivedAt": null,
"promptType": "simple",
"flowData": {
"nodes": [],
"edges": []
},
"prompt": "Keep the conversation short and friendly.",
"isActive": true,
"settings": {
"knowledgeBases": [],
"security": { "hipaaCompliance": false },
"callSetting": {
"maxCallDuration": 600,
"endCallOnSilence": 10,
"silenceReminderRetries": 1,
"endCallAfterReminder": 10
},
"welcomeMessageConfig": {
"Inbound": {
"aiGreetingPrompt": "",
"customMessage": "Thanks for calling Acme Plumbing, how can I help you?",
"selected": "customMessage",
"userFirstFallbackDelaySeconds": 10,
"userFirstFallbackMessage": ""
},
"Outbound": {
"aiGreetingPrompt": "",
"customMessage": "",
"selected": "aiFirst",
"userFirstFallbackDelaySeconds": 10,
"userFirstFallbackMessage": ""
}
}
},
"createdAt": "2025-01-03T11:00:00Z",
"updatedAt": "2025-01-03T11:10:00Z"
}Last updated on