List call flows

GET

https://{your_space_name}.signalwire.com/api/fabric/resources/call_flows

GET

/api/fabric/resources/call_flows

curl https://{your_space_name}.signalwire.com/api/fabric/resources/call_flows \
     -u "<project_id>:<api_token>"

{
  "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
      }
    }
  ]
}

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice, Messaging, Fax, or Video.

Learn more about API scopes.

Lists the Call Flows in your SignalWire project. A Call Flow is a visual, reusable call handler built in Call Flow Builder; it can be assigned to phone numbers and other routing resources. Use [SWML Scripts](/docs/apis/rest/swml-scripts/list-swml-scripts) when you author SWML directly, or a [Relay Application](/docs/apis/rest/relay-application/list-relay-applications) when a Server SDK process handles the call. #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space).

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Response

The request has succeeded.

linksobject

Object containing pagination links

datalist of objects

An array of objects containing the CallFlow listing response

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error