Read user contact

GET

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

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

OperationId:ReadContactForUser

Returns one contact from a user's address book.

Basic User, Advanced User, Simple User, Call Center Agent, and Call Center Supervisor can read their own contacts only. Site Manager can read its own contacts and those of users at its own site. Office Manager can read the contacts of any user in its domain, Reseller those of users in domains of its territory, and Super User any user's. Super User Read Only and Office Manager Read-Only can read too, platform-wide and in their own domain. A request for any other address book returns 403.

The ID must name a contact in the user's personal address book or one of the domain's shared contacts; any other ID returns 404. The read returns the stored contact only, without directory data. Append /list to the path (.../contacts/{contact_id}/list) for the reduced row.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Responses

🟢200OK

application/json

The contact.

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//contacts/5f2b7c9e1a4d8e3b6c0f9a2d7e1b4c8a' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Personal contact

{
    "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"
    ]
}

Modified at 2026-10-09 00:37:55

Create user contact

Update user contact