List routes

GET

/routes

Last modified:2026-10-09 01:07:08

OperationId:GetRoutes

Returns the platform's call routes from route_config, each with the route-id you use to read, update, or delete it and to manage its route connections. Routes apply to the whole platform, not to one domain or territory. Requires Super User, Reseller, or Super User Read Only scope.

Without route-destination-match-pattern, the list holds only routes whose destination pattern starts with sip and contains @, such as sip:1800*@*. That leaves out the routes behind route profiles, which you read with GET /domains/{domain}/routeprofiles. Every filter is an exact match, and filters combine. Rows are sorted by route-destination-match-pattern and paged with start and limit, 100 rows by default.

GET /routes/count takes the same filters and counts the same rows. GET /routes/{route-id} returns one route.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Query Params

Responses

🟢200OK

application/json

The matching routes, sorted by route-destination-match-pattern. No match returns [].

Bodyapplication/json

🟠400Bad Request

🟠401Authentication Required

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/routes?route-destination-match-pattern=sip%3A1800*%40*&route-source-match-pattern=*&route-class=*&route-match-server-hostname=core1.example.com&start=undefined&limit=undefined' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Two routes

A route for every core server and one limited to core1.example.com.

[
    {
        "route-destination-match-pattern": "sip:1800*@*",
        "route-source-match-pattern": "*",
        "route-class": "*",
        "route-match-server-hostname": "*",
        "route-is-enabled": "yes",
        "description": "Toll-free outbound",
        "route-method": "cost",
        "route-id": "c2lwOjE4MDAqQCo"
    },
    {
        "route-destination-match-pattern": "sip:1800*@*",
        "route-source-match-pattern": "*",
        "route-class": "*",
        "route-match-server-hostname": "core1.example.com",
        "route-is-enabled": "yes",
        "description": "Toll-free outbound from core1",
        "route-method": "fixed",
        "route-id": "c2lwOjE4MDAqQCp8fCp8fCp8fGNvcmUxLmV4YW1wbGUuY29t"
    }
]

Modified at 2026-10-09 01:07:08

List domain connections, reduced

Count routes