Read site

GET

/domains/{domain}/sites/{site}

Last modified:2026-10-08 23:11:54

OperationId:ReadSiteInDomain

Returns one site with its settings and live counts of users, call queues, devices, registered devices, and active calls.

Requires Office Manager, Site Manager, or Basic User in the domain, Reseller for a domain in your territory, or Super User or Super User Read Only. A Site Manager and a Basic User see every site in the domain, not only their own. Other scopes, and a Reseller outside its territory, get 403.

This read returns a shorter field set than the list: the name in site and user, the site's limits, dial plan and dial policy, caller ID, area code, time zone, language, emergency address, and the counts count-users-total, count-call-queues, count-devices-total, count-devices-registered, and active-calls-total-current. When the site has no emergency address of its own, emergency-address-id is the domain's and emergency-address-source is domain_level.

A name with no site returns 404. So does a site created a moment ago, until its create is applied.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Responses

🟢200OK

application/json

The site, with its counts.

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/Main Office' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Site with counts

A site with 12 users and 2 call queues.

{
    "site": "Main Office",
    "user": "Main Office",
    "domain": "example.com",
    "voicemail-user-control-enabled": "yes",
    "limits-max-data-storage-kilobytes": "0",
    "limits-max-active-calls-total": "0",
    "dial-plan": "example.com",
    "dial-policy": "US and Canada",
    "area-code": "555",
    "caller-id-name": "Example Main Office",
    "caller-id-number": "15555550100",
    "caller-id-number-emergency": "15555550100",
    "ring-no-answer-timeout-seconds": "25",
    "time-zone": "America/New_York",
    "language-token": "en_US",
    "last-modified-datetime": "2026-09-01T14:30:00+00:00",
    "emergency-address-id": "A1B2C3D4",
    "count-users-total": 12,
    "count-call-queues": 2,
    "count-devices-registered": 9,
    "count-devices-total": 14,
    "active-calls-total-current": 3
}

Modified at 2026-10-08 23:11:54

Update site

Delete site