List domain directory

GET

/domains/{domain}/users/list

Last modified:2026-10-08 23:06:23

OperationId:ListUsers

Returns the domain directory: the extension, name, site, department, and dial-by-name digits of each user. Any user scope in the domain can call it, Basic User included. It is the read to use for a contact picker or a dial-by-name list.

Users are sorted by extension. Every user is returned unless you set limit. Filter on any field shown by the response, such as site, or on user-scope or service-code. Paging with start and ordering with sort are not available on this read.

By default the directory leaves out system users, such as call queues and auto attendants, the rows that represent sites and departments, and the domain placeholder user. filter_users replaces that default and also takes noVmail, which keeps only users with voicemail.

fields takes only these names: user, domain, site, name-first-name, name-last-name, department, and directory-name-number-dtmf-mapping. Any other name is a 400. Without fields, all of them are returned.

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. 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-08 23:06:23

Read my user

List users (older path)