Read user avatar by filename

GET

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

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

OperationId:ReadUserAvatarFile

Returns the metadata of one of the user's stored avatars, addressed by its filename.

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.

The avatar must belong to the user the path names, or the call 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 read the current avatar without knowing its filename, call GET /domains/{domain}/users/{user}/avatar. Only GET and DELETE are served on this path; POST and PUT return 405 Method Not Allowed. Upload to the avatar collection path, not to a filename.

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

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/5f0c2d8e9b7a4c1d3e6f8a0b2c4d6e8f.webp' \
--header 'Authorization: Bearer <token>'

Response Example

200 - User avatar

{
    "filename": "5f0c2d8e9b7a4c1d3e6f8a0b2c4d6e8f.webp",
    "user": "1001",
    "domain": "example.com",
    "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:52:00

Replace user avatar

Delete user avatar by filename