GET
/
v1
/
api
/
call-flows
curl --request GET \
  --url https://api.trillet.ai/v1/api/call-flows \
  --header 'x-api-key: <api-key>' \
  --header 'x-workspace-id: <x-workspace-id>'
[
  {
    "_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",
    "__v": 0
  },
  {
    "_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",
    "__v": 0
  }
]

Headers

x-api-key
string
required

API key used for authenticating requests to the API.

x-workspace-id
string
required

Workspace identifier for the API.

Response Fields

Each object in the response array represents a call flow within the workspace, containing the following fields:

_id
string

The unique identifier for the call flow.

workspaceId
string

The identifier of the workspace where the call flow is configured.

name
string

The name assigned to the call flow.

direction
string

Indicates the direction of the call flow, such as “inbound” or “bidirectional”.

agent
string

The identifier of the agent associated with the call flow.

isActive
boolean

A boolean indicating whether the call flow is currently active.

promptType
string

The type of prompt used in the call flow, either “simple” or “flow”.

createdAt
string

Timestamp when the call flow was updated.

updatedAt
string

Timestamp when the call flow was last updated.

__v
number

The version number of the call flow document, indicating how many times it has been 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",
    "__v": 0
  },
  {
    "_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",
    "__v": 0
  }
]