List domain directory

GET

/domains/{domain}/users/list

Last modified:2026-10-30 21:06:03

OperationId:ListUsers

Returns the domain directory: each user's extension, name, site, department, and dial-by-name digits. Use it for a contact picker or a dial-by-name list. Any user scope in the domain can call it, Basic User included.

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 directory, sorted by extension. An empty array when no user matches.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/domains//users/list?fields=user%2Cname-first-name%2Cname-last-name&site=Main%20Office&user-scope=Office%20Manager&service-code=system-queue&filter_users=system%2CnoVmail&limit=25' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Directory

[
    {
        "user": "1001",
        "domain": "example.com",
        "site": "Main Office",
        "name-first-name": "Front",
        "name-last-name": "Desk",
        "department": "Reception",
        "directory-name-number-dtmf-mapping": 337
    },
    {
        "user": "1002",
        "domain": "example.com",
        "site": "Main Office",
        "name-first-name": "Sales",
        "name-last-name": "Lead",
        "department": "Sales",
        "directory-name-number-dtmf-mapping": 532
    },
    {
        "user": "1003",
        "domain": "example.com",
        "site": "Branch Office",
        "name-first-name": "Support",
        "name-last-name": "Line",
        "department": "Support",
        "directory-name-number-dtmf-mapping": 546
    }
]

Modified at 2026-10-30 21:06:03

Read my user

List users (older path)