List Call Flows
Retrieve a list of all call flows in the workspace.
GET
Headers
x-api-keystringrequiredAPI key used for authenticating requests to the API.
x-workspace-idstringrequiredWorkspace identifier for the API.
Response Fields
Each object in the response array represents a call flow within the workspace, containing the following 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.
directionstringIndicates the direction of the call flow, such as "inbound" or "bidirectional".
agentstringThe identifier of the agent associated with the call flow.
isActivebooleanA boolean indicating whether the call flow is currently active.
promptTypestringThe type of prompt used in the call flow, either "simple" or "flow".
createdAtstringTimestamp when the call flow was updated.
updatedAtstringTimestamp when the call flow was last updated.
[
{
"_id": "flowId1",
"workspaceId": "workspaceIdExample1",
"name": "Customer Support Flow",
"direction": "inbound",
"agent": "agentIdExample1",
"isActive": true,
"promptType": "simple",
"createdAt": "2025-01-02T09:00:00Z",
"updatedAt": "2025-01-02T09:30:00Z"
},
{
"_id": "flowId2",
"workspaceId": "workspaceIdExample2",
"name": "Sales Inquiry Flow",
"direction": "bidirectional",
"agent": "agentIdExample2",
"isActive": false,
"promptType": "flow",
"createdAt": "2025-01-05T09:00:00Z",
"updatedAt": "2025-01-06T12:00:00Z"
}
]