List sites

GET

/domains/{domain}/sites

Last modified:2026-10-30 21:36:38

OperationId:ReadSitesDomain

Returns the domain's sites with every stored setting, sorted by name. A site is a system extension holding shared settings, such as dial plan, caller ID, time zone, and emergency address, for the users and call queues filed under it. Requires Office Manager, Site Manager, or Basic User scope in the domain, Reseller scope for a domain in your territory, or Super User or Super User Read Only scope.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Query Params

Responses

🟢200OK

application/json

The domain's sites, possibly an empty array. The name is in site and user. A Site Manager and a Basic User see every site in the domain, not only their own.

Bodyapplication/json

🟠401Authentication Required

🟠403Forbidden

🟠404Record not found

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/domains//sites?limit=undefined&start=undefined&sort=user%20desc&fields=site%2Cdial-plan%2Ctime-zone&site=Main%20Office&billing=yes' \
--header 'Authorization: Bearer <token>'

Response Example

200 - One site

A site with its own emergency address.

[
    {
        "site": "Main Office",
        "user": "Main Office",
        "domain": "example.com",
        "name-first-name": "Main Office",
        "name-last-name": "Site",
        "login-username": "Main Office@example.com",
        "service-code": "system-site",
        "dial-plan": "example.com",
        "dial-policy": "US and Canada",
        "caller-id-name": "Example Main Office",
        "caller-id-number": "15555550100",
        "caller-id-number-emergency": "15555550100",
        "area-code": "555",
        "time-zone": "America/New_York",
        "language-token": "en_US",
        "limits-max-active-calls-total": "0",
        "limits-max-data-storage-kilobytes": "0",
        "ring-no-answer-timeout-seconds": "25",
        "emergency-address-id": "A1B2C3D4",
        "voicemail-enabled": "yes",
        "active-calls-total-current": 0,
        "created-datetime": "2026-09-01T14:30:00+00:00",
        "last-modified-datetime": "2026-09-01T14:30:00+00:00"
    }
]

Modified at 2026-10-30 21:36:38

List site summaries

Count sites