Skip to navigation
REST ClientFabricCall Flows

list

View as MarkdownOpen in Claude

List call flow resources in the project.

Response

datalist of objectsRequired
An array of objects containing the CallFlow listing response

Response Example

Response
{
  "links": {
    "self": "https://example.signalwire.com/api/fabric/resources/call_flows?page_number=0&page_size=50",
    "first": "https://example.signalwire.com/api/fabric/resources/call_flows?page_number=0&page_size=50"
  },
  "data": [
    {
      "id": "993ed018-9e79-4e50-b97b-984bd5534095",
      "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
      "display_name": "Welcome Call Flow",
      "type": "call_flow",
      "created_at": "2024-05-06T12:20:00Z",
      "updated_at": "2024-05-06T12:25:00Z",
      "call_flow": {
        "id": "993ed018-9e79-4e50-b97b-984bd5534095",
        "title": "Welcome Call Flow",
        "flow_data": {},
        "relayml": {
          "sections": {
            "main": [
              {
                "play": {
                  "url": "https://cdn.signalwire.com/swml/audio.mp3"
                }
              }
            ]
          },
          "version": "1.0.0"
        },
        "document_version": 1
      }
    }
  ]
}

Example

import { RestClient } from "@signalwire/sdk";
const client = new RestClient({
  project: "your-project-id",
  token: "your-api-token",
  host: "your-space.signalwire.com"
});
const response = await client.fabric.callFlows.list();
for (const flow of response.data ?? []) {
  console.log(`${flow.display_name}: ${flow.id}`);
}