Read user avatar

GET

/domains/{domain}/users/{user}/avatar

Last modified:2026-10-09 00:51:49

OperationId:ReadUserAvatar

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

Basic User, Advanced User, Simple User, and Call Center Agent can read their own avatar only. Site Manager can read its own and those of users at its own site only. Office Manager, Office Manager Read-Only, and Call Center Supervisor can read those of any user in their domain, Reseller those of users in domains of its territory, and Super User and Super User Read Only any user's. Any other user returns 403.

A user with no avatar returns 404. 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. To upload one, call POST /domains/{domain}/users/{user}/avatar. Deleting the user deletes its avatar and its contacts' avatars too.

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 user's avatar.

Bodyapplication/json

🟠404Record not found

🟠400Bad Request

🟠401Authentication Required

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - User 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"
    }
]

Modified at 2026-10-09 00:51:49

Delete user avatar by filename

Count user avatars