List shared contacts

GET

/domains/{domain}/contacts

Last modified:2026-10-09 00:37:19

OperationId:GetDomainContacts

Lists the domain's shared contacts: the address book every user in the domain sees alongside their own.

Every scope in the domain can read its shared contacts: Basic User, Advanced User, Simple User, Call Center Agent, Call Center Supervisor, Site Manager, and Office Manager. Reseller can read those of domains in its territory, and Super User and Super User Read Only those of any domain. A scope from another domain gets 403.

Shared contacts are marked is-shared: true. Rows are sorted with directory users by extension first, then by last name and first name, unless you send sort, and paged with start and limit, which defaults to 100 and is clamped to 1 to 1,000. With includeDomain=yes, the users in the domain directory are added as on-net rows. Count them with GET /domains/{domain}/contacts/count, or get reduced rows with GET /domains/{domain}/contacts/list.

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 shared contacts, sorted and paged. A domain with none 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//contacts?name-first-name=Front&name-last-name=Desk&tags=cg-Vendors&includeDomain=yes&department=Sales&site=Main%20Office&sort=name-last-name%20asc&limit=100&start=undefined' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Shared contacts

[
    {
        "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-09 00:37:19

Delete shared contacts by name

Create shared contact