List Provisioned Routes

GET

https://platform-api.convirza.com/v3/provisioned-routes

Provisioned Routes

Last modified:2026-04-03 14:27:57

Retrieves a paginated, filterable list of call-routing tracking numbers associated with the authenticated account.

Filtering Options

provisioned_route_status — Filter by route status: active, inactive, referral, deleted, or suspended

phone_number — Find a specific tracking number (exact digits match)

provisioned_route_name — Search by route name (partial, case-insensitive)

org_unit_id — Scope results to a specific organization unit

Sorting & Pagination

Results are paginated via page (zero-based) and limit (max 500)

Sort by provisioned_route_name, provisioned_route_status, or phone_number

Note: To look up a specific route by ID, use GET /provisioned-routes/{provisioned_route_id} instead of this endpoint.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Responses

🟢200

application/json

Provisioned routes retrieved successfully

Body

🟠400

🟠401

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://platform-api.convirza.com/v3/provisioned-routes?offset&limit&orderBy&order&org_unit_id&provisioned_route_name&provisioned_route_status&phone_number' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "code": 200,
    "message": "Success",
    "data": {
        "routes": [
            {
                "provisioned_route_id": "12345",
                "provisioned_route_name": "Spring Campaign - Organic",
                "provisioned_route_status": "active",
                "phone_number": "4058737820"
            }
        ],
        "total": 25
    },
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-03-27T10:30:00.000Z"
}

Modified at 2026-04-03 14:27:57

Available Numbers

Create Provisioned Route