List user contacts

GET

/domains/{domain}/users/{user}/contacts

Last modified:2026-10-30 22:36:49

OperationId:GetContactsUser

Lists the contacts a user sees: their personal contacts, the domain's shared contacts, and, with includeDomain=yes, the users in the domain directory. Every scope except No Portal can read its own address book, and Site Manager, Office Manager, Reseller, Super User, Super User Read Only, and Office Manager Read-Only can also read those of the users they administer.

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 contacts, sorted and paged. Personal contacts come first, then the domain's shared contacts, marked is-shared: true and left out when a domain or reseller setting hides shared contacts, then the directory rows. A user with no contacts answers an empty array.

Bodyapplication/json

🟠400Bad Request

🟠401Authentication Required

🟠404Record not found

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/domains//users//contacts?includeDomain=yes&name-first-name=Front&name-last-name=Desk&tags=cg-Vendors&department=Sales&site=Main%20Office&sort=name-last-name%20asc&limit=100&start=undefined' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Personal, shared, and directory rows

includeDomain=yes: a personal favorite, a shared contact, and a directory user.

[
    {
        "unique-id": "5f2b7c9e1a4d8e3b6c0f9a2d7e1b4c8a",
        "name-first-name": "Front",
        "name-middle-name": "",
        "name-last-name": "Desk",
        "company": "Example Supply Co",
        "email": "frontdesk@example.com",
        "phonenumber-work": "15555550100",
        "phonenumber-cell": "15555550101",
        "phonenumber-home": "",
        "phonenumber-fax": "",
        "notes": "Deliveries before noon",
        "avatar": "1a79a4d60de6718e8e5b326e338ae533.webp",
        "created-datetime": "2026-09-01T14:30:00+00:00",
        "domain": "example.com",
        "is-shared": false,
        "is-favorite": true,
        "groups": [
            "Vendors"
        ]
    },
    {
        "name-first-name": "Sales",
        "name-last-name": "Queue",
        "domain": "example.com",
        "department": "Sales",
        "site": "Main Office",
        "user": "1002",
        "uid": "1002@example.com",
        "matrix_user_id": "",
        "email": "user1002@example.com",
        "user-presence-status": "open",
        "avatar": "",
        "is-shared": false,
        "is-favorite": false,
        "groups": []
    },
    {
        "unique-id": "0c4e8a2f6b1d9e3a7c5f0b8d2e6a4c1f",
        "name-first-name": "Support",
        "name-middle-name": "",
        "name-last-name": "Line",
        "company": "Example Services",
        "email": "support@example.com",
        "phonenumber-work": "15555550110",
        "phonenumber-cell": "",
        "phonenumber-home": "",
        "phonenumber-fax": "15555550111",
        "notes": "",
        "avatar": "",
        "created-datetime": "2026-08-20T09:15:00+00:00",
        "domain": "example.com",
        "is-shared": true,
        "is-favorite": false,
        "groups": []
    }
]

Modified at 2026-10-30 22:36:49

Delete user contacts by name

Create user contact