List Outbound IVR Flows

GET

/v1/outbound-ivr/flows

Returns flows belonging to the caller's workspace only.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Query Params

Responses

🟢200

application/json

Paged list of flows

Bodyapplication/json

🟠403MissingVoxaApiScope

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.voxa.sa/v1/outbound-ivr/flows?skipCount=undefined&maxResultCount=undefined' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "totalCount": 0,
    "items": [
        {
            "name": "Sales pre-qualification",
            "steps": [
                {
                    "key": "budget",
                    "type": 1,
                    "questionProps": {
                        "audioFileUrl": "http://example.com",
                        "options": [
                            {
                                "digit": "1",
                                "description": "Confirm the appointment",
                                "responseMessageFileUrl": "http://example.com"
                            }
                        ]
                    }
                }
            ],
            "welcomeAudioFileUrl": "http://example.com",
            "completionAudioFileUrl": "http://example.com",
            "noInputAudioFileUrl": "http://example.com",
            "continueOnNoInput": false,
            "maxAudioRetries": 2,
            "inputTimeoutMs": 6000,
            "digitTimeoutMs": 3000,
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c",
            "creationTime": "2019-08-24T14:15:22.123Z"
        }
    ]
}

Modified at 2026-08-14 17:40:40

Create Outbound IVR Flow

Get Outbound IVR Flow