Read route profile

GET

/routeprofiles/{connection-id}

Last modified:2026-09-26 18:01:21

OperationId:readRouteProfile

Returns one route profile by connection-id, without naming its domain. Requires Office Manager, Route Manager, Call Center Supervisor, or Office Manager Read-Only scope in the profile's domain, Reseller scope in its territory, or Super User or Super User Read Only scope.

An id that names no route profile returns 404, and so does the id of an ordinary connection.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Responses

🟢200

application/json

The route profile.

Bodyapplication/json

🟠401Authentication Required

🟠403Forbidden

🟠404Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/routeprofiles/dG9sbGZyZWU' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Toll-free profile

One route profile.

{
    "connection-id": "dG9sbGZyZWU",
    "connection-orig-match-pattern": "tollfree",
    "connection-term-match-pattern": "tollfree",
    "domain": "example.com",
    "description": "Toll-free outbound chain",
    "connection-usage-role": "customer",
    "connection-connectivity-type": "route_profile",
    "call-routing": {
        "route-destination-match-pattern": "EXAMPLE.COM_tollfree",
        "route-source-match-pattern": "*",
        "route-class": "*",
        "route-match-server-hostname": "*",
        "route-is-enabled": "yes",
        "description": "Toll-free outbound chain",
        "route-method": "percentage",
        "routecon": [
            {
                "route-connection-ordinal-index": 1,
                "route-connection-translation-destination-user": "[*]",
                "route-connection-translation-destination-host": "carrier1.example.com",
                "route-connection-integer-percentage": 60,
                "route-connection-integer-cost": 0
            },
            {
                "route-connection-ordinal-index": 2,
                "route-connection-translation-destination-user": "[*]",
                "route-connection-translation-destination-host": "carrier2.example.com",
                "route-connection-integer-percentage": 40,
                "route-connection-integer-cost": 0
            }
        ]
    }
}

Modified at 2026-09-26 18:01:21

List route profiles

Update route profile