Read shared contact avatar

GET

/domains/{domain}/contacts/{contact_id}/avatar

Last modified:2026-10-09 00:52:33

OperationId:ReadDomainContactAvatar

Returns the metadata of the avatar of one of the domain's shared contacts: filename, file sizes, the image paths, and when it was stored. The answer is a list, normally of one row.

Access follows the contact's own: every scope in the domain can read the avatars of its shared contacts. 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.

The contact must be a shared contact of the domain, or the call returns 404, as does a contact with no avatar. The image itself is served without authentication at path (at most 48 by 48 pixels), path-small (the same image), and path-large (at most 256 by 256 pixels), so anyone who has the filename can load it.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Responses

🟢200Success

application/json

The contact's avatar.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/domains//contacts/5f2b7c9e1a4d8e3b6c0f9a2d7e1b4c8a/avatar' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Shared contact avatar

[
    {
        "filename": "5f0c2d8e9b7a4c1d3e6f8a0b2c4d6e8f.webp",
        "filetype": "image/webp",
        "filesize-large-bytes": 7852,
        "filesize-small-bytes": 1026,
        "path-large": "/ns-api/v2/avatar/256/5f0c2d8e9b7a4c1d3e6f8a0b2c4d6e8f.webp",
        "path-small": "/ns-api/v2/avatar/48/5f0c2d8e9b7a4c1d3e6f8a0b2c4d6e8f.webp",
        "path": "/ns-api/v2/avatar/5f0c2d8e9b7a4c1d3e6f8a0b2c4d6e8f.webp",
        "created-datetime": "2026-09-01T14:30:00+00:00",
        "contact_id": "5f2b7c9e1a4d8e3b6c0f9a2d7e1b4c8a"
    }
]

Modified at 2026-10-09 00:52:33

Delete user contact avatar

Delete shared contact avatar