Get Folder Details with Flows

Retrieve the details of a specific folder, including its associated flows, by its folderId.

GET /v1/api/flow-folders/{folderId}

Get Folder Details with Flows

cURL

curl --request GET \
  --url https://api.trillet.ai/v1/api/flow-folders/{folderId} \
  --header 'x-api-key: <api-key>'

{
  "_id": "folder123",
  "workspaceId": "workspace456",
  "name": "My Workflow Folder",
  "color": "#FF0000",
  "icon": "folder-icon",
  "flowType": "call",
  "pathwayModel": "Flow",
  "pathways": [
    {
      "_id": "flow123",
      "name": "Support Call Flow",
      "description": "Handles customer support calls",
      "createdAt": "2023-10-15T10:00:00Z",
      "updatedAt": "2023-10-15T10:00:00Z"
    }
  ],
  "createdAt": "2023-10-15T09:30:00Z",
  "updatedAt": "2023-10-15T10:00:00Z"
}

Path Parameters

folderId · string · required

The unique identifier of the folder whose details are being requested.

Response Fields

_id · string

The unique identifier of the folder.

workspaceId · string

The identifier of the workspace where the folder belongs.

name · string

The name of the folder.

color · string

The color of the folder, represented as a hex code.

icon · string

The icon identifier for the folder.

flowType · string

The type of flow, either “call” or “message”.

pathwayModel · string

The model type for flows, derived from flowType.

pathways · array

An array of flow objects associated with the folder. Each flow object contains details such as its ID, name, and other relevant information.

createdAt · string

Timestamp when the folder was created (ISO 8601 format).

updatedAt · string

Timestamp when the folder was last updated (ISO 8601 format).

{
  "_id": "folder123",
  "workspaceId": "workspace456",
  "name": "My Workflow Folder",
  "color": "#FF0000",
  "icon": "folder-icon",
  "flowType": "call",
  "pathwayModel": "Flow",
  "pathways": [
    {
      "_id": "flow123",
      "name": "Support Call Flow",
      "description": "Handles customer support calls",
      "createdAt": "2023-10-15T10:00:00Z",
      "updatedAt": "2023-10-15T10:00:00Z"
    }
  ],
  "createdAt": "2023-10-15T09:30:00Z",
  "updatedAt": "2023-10-15T10:00:00Z"
}