List Message Flows
Retrieve a list of all message flows.
Headers
x-workspace-idstringrequiredWorkspace identifier for the API.
Response Fields
Each object in the response array represents a message flow, containing the following fields:
_idstringThe unique identifier for each message flow.
workspaceIdstringThe identifier of the workspace where each message flow is configured.
namestringThe name of the message flow.
directionstringIndicates the direction of the message flow, such as "bidirectional" or "outbound".
descriptionstringA brief description of what the message flow is designed to handle.
agentobjectThe message agent the flow uses, as a full agent object (use agent._id for its ID), or null.
folderIdobjectThe folder the flow is in, as { _id, name, icon, color }, or null.
settingsobjectThe configuration settings for the message flow. This field may contain various subfields depending on the specific configurations set for each flow.
promptstringThe system or initial prompt set for interacting through the message flow.
isActivebooleanIndicates whether the message flow is currently active.
autopilotbooleanWhether replies are sent automatically without approval. Separate from isActive.
messageChannelstringThe channel: Twilio-SMS, Telnyx-SMS, Twilio-Email, Meta-Whatsapp, Meta-Facebook, Infobip-Whatsapp or Infobip-Facebook.
createdAtstringThe timestamp when the message flow was created.
updatedAtstringThe timestamp when the message flow was last updated.
[
{
"_id": "exampleId1",
"workspaceId": "exampleWorkspaceId1",
"name": "SMS Flow #1",
"direction": "bidirectional",
"description": "Example #1",
"agent": { "_id": "c9c9c9c9c9c9c9c9c9c9c9c9", "name": "SMS Agent" },
"folderId": null,
"settings": {},
"prompt": "Short prompt for AI",
"isActive": true,
"autopilot": false,
"messageChannel": "Twilio-SMS",
"createdAt": "2025-01-02T10:15:00Z",
"updatedAt": "2025-01-02T10:30:00Z"
},
{
"_id": "exampleId2",
"workspaceId": "exampleWorkspaceId2",
"name": "Email Nurture Flow",
"direction": "outbound",
"description": "Send follow-up emails to leads",
"agent": { "_id": "c9c9c9c9c9c9c9c9c9c9c9c9", "name": "SMS Agent" },
"folderId": null,
"settings": {},
"prompt": "You are an email follow-up AI.",
"isActive": false,
"autopilot": false,
"messageChannel": "Twilio-Email",
"createdAt": "2025-01-03T11:00:00Z",
"updatedAt": "2025-01-03T11:15:00Z"
}
]
Last updated on