List Provisioned Routes

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

campaign_id — Filter by campaign ID to show only routes associated with a specific campaign

Sorting & Pagination

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

Sort by provisioned_route_name, provisioned_route_status, or phone_number

Optional Includes (via ?include=module1,module2)

dni_data — DNI (Dynamic Number Insertion) settings including org-level config and route-specific settings. Disabled by default for performance.

Response Fields

All routes include: provisioned_route_id, provisioned_route_name, provisioned_route_status, phone_number, org_unit_id, org_unit_ext_id, org_unit_name, campaign_id, campaign_ext_id, campaign_name, sms_feature

When ?include=dni_data is used: adds dni_data (array) and dni_enabled (boolean) fields

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

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

curl --location 'https://platform-api.convirza.com/v3/provisioned-routes?offset=&limit=&sort_by=&sort_order=&org_unit_id=&provisioned_route_name=&provisioned_route_status=&phone_number=&routing_type=&campaign_id=&include=' \ --header 'Authorization: Bearer <token>'

{ "code": 200, "message": "Success", "data": { "routes": [ { "provisioned_route_id": "12345", "provisioned_route_name": "Spring Campaign - Organic", "provisioned_route_status": "active", "phone_number": "4058737820", "org_unit_id": 10001, "org_unit_ext_id": "ORG-12345", "org_unit_name": "Sales Department", "campaign_id": 789, "campaign_ext_id": 456, "campaign_name": "Spring 2026 Campaign", "sms_feature": "enabled", "dni_data": [ { "dni_org_unit": [ { "org_unit_id": 10001, "custom_params": "utm_source={{source}}", "dni_code": "dni_abc123" } ], "dni_settings": [ { "dni_setting_id": 123, "dni_setting_name": "Homepage DNI", "dni_type": "static", "destination_url": "https://example.com" } ] } ], "dni_enabled": true } ], "total": 25 }, "request_id": "550e8400-e29b-41d4-a716-446655440000", "timestamp": "2026-03-27T10:30:00.000Z" }

List Provisioned Routes

Request

Responses