List domain device summaries

GET

/domains/{domain}/devices/list

Last modified:2026-10-08 23:07:33

OperationId:ListDomainDevices

Returns a short view of every device in the domain: its name, SIP URI, owner, user agent, and registration state.

Requires Basic User, Site Manager, Office Manager, Reseller, Super User, or Super User Read Only, in your own domain or one you administer. A Site Manager always gets its own site, and naming another site returns 403.

It is served by the /list suffix, which differs from the full read in two ways:

Fewer fields. Only the six fields of DeviceListItem, with no provisioning fields and no credentials.

A different privilege. /list is checked against the list privilege, the one /count uses, not read. So a scope that cannot read the full records can still see these.

Appending /list to a single device's path returns the same fields for that one device.

Filter with site and device-sip-registration-state, order with sort, and page with start and limit. Use GET /domains/{domain}/devices for the full fields.

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

🟢200Success

application/json

The domain's device summaries, possibly an empty array.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/domains//devices/list?limit=100&start=undefined&site=Main%20Office&device-sip-registration-state=registered&sort=user%20asc%2Cdevice-sip-registration-uri' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Two devices

Summaries of two devices.

[
    {
        "device": "1001a",
        "device-sip-registration-uri": "sip:1001a@example.com",
        "user": "1001",
        "domain": "example.com",
        "device-sip-registration-user-agent": "Yealink SIP-T54W 198.51.100.20",
        "device-sip-registration-state": "registered"
    },
    {
        "device": "1002",
        "device-sip-registration-uri": "sip:1002@example.com",
        "user": "1002",
        "domain": "example.com",
        "device-sip-registration-user-agent": null,
        "device-sip-registration-state": "unregistered"
    }
]

Modified at 2026-10-08 23:07:33

Reboot domain devices in bulk

List user device summaries