List dial plans

GET

/dialplans

Last modified:2026-10-08 22:59:47

OperationId:ReadDialplans

Returns the dial plans your token can see. What that covers depends on your scope:

Super User and Super User Read Only: every plan on the platform. Send territory to narrow it to one territory

Reseller: plans owned by domains in your territory

Office Manager, Site Manager, and every other scope: 403. Use GET /domains/{domain}/dialplans instead

Both also see the platform-shared plans, whose domain is admin-only or *. For the total, call /dialplans/count. For one admin-only plan, use GET /dialplans/{dialplan}.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Query Params

Responses

🟢200Success

application/json

The dial plans your token can see.

Bodyapplication/json

🟠400Bad Request

🟠401Authentication Required

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/dialplans?dial-rule-dial-plan=example.com&dial-rule-description=%holiday%&territory=example-reseller&start=undefined&limit=100' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Dial plans

[
    {
        "domain": "example.com",
        "dial-rule-dial-plan": "example.com",
        "dial-rule-description": "dialplan for example.com"
    },
    {
        "domain": "admin-only",
        "dial-rule-dial-plan": "DID Table",
        "dial-rule-description": "Platform DID routing"
    }
]

Modified at 2026-10-08 22:59:47

Delete dial rule

Create dial plan with domain in body