Get Folder Details
Get a folder with the full details of the flows in it.
Headers
x-workspace-idstringrequiredThe workspace the folder belongs to. Folders and flows in other workspaces are treated as not found.
Path Parameters
folderIdstringrequiredThe folder's _id.
Response
The folder, with pathways expanded:
_idstringThe folder's unique identifier.
workspaceIdstringThe workspace the folder belongs to.
namestringThe folder name.
colorstringThe folder color, stored exactly as sent (default #3498db).
iconstringThe folder icon, stored exactly as sent (default folder).
flowTypestringcall or message.
pathwayModelstringPathway for call folders, MessagePathway for message folders. Set by the server from flowType.
pathwaysarrayThe full call flow or message flow objects in the folder (every field, the same shape as Get Call Flow or Get Message Flow). Only flows in this workspace are included.
createdAtstringWhen the folder was created (ISO 8601). Folders have no updatedAt.
Errors
All folder errors use a message field, not error.
| Status | Body | When |
|---|---|---|
400 | {"message": "x-workspace-id header is required"} | x-workspace-id missing or not a valid ID |
404 | {"message": "Folder not found"} | No folder with that ID in this workspace |
500 | {"message": "..."} | Unexpected server error |
{
"_id": "b2b2b2b2b2b2b2b2b2b2b2b2",
"workspaceId": "b4b4b4b4b4b4b4b4b4b4b4b4",
"name": "Inbound Flows",
"color": "#3B82F6",
"icon": "folder",
"flowType": "call",
"pathways": [
{
"_id": "b7b7b7b7b7b7b7b7b7b7b7b7",
"name": "Front desk",
"workspaceId": "b4b4b4b4b4b4b4b4b4b4b4b4",
"folderId": "b2b2b2b2b2b2b2b2b2b2b2b2",
"direction": "bidirectional",
"...": "..."
}
],
"pathwayModel": "Pathway",
"createdAt": "2026-10-15T09:30:00.000Z",
"__v": 0
}Last updated on