List user settings

GET

/domains/{domain}/users/{user}/settings

Last modified:2026-10-09 00:58:30

OperationId:ListUserSettings

Returns every setting stored for the user in the path, with its value. A setting is a named per-user preference that an app saves and reads back, such as a dashboard layout or a display option.

Office Manager can read the settings of every user in its domain, and Site Manager its own settings and those of users in its site. Basic User, Advanced User, Simple User, Call Center Agent, Call Center Supervisor, Route Manager, and Office Manager Read-Only can read their own settings only. Reseller can read the settings of users in its domains, and Super User or Super User Read Only the settings of any user. The user in the path decides access: a uid in the query has no effect.

All settings are returned in one response, with no paging. A user with no settings returns an empty array. A user's settings are removed when the user is deleted. To list only the setting names, use List user setting names. To read one setting, use Read user setting.

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 user's settings. An empty array when the user has none.

Bodyapplication/json

🟠401Authentication Required

🟠403Forbidden

🟠404Record not found

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Settings

[
    {
        "domain": "example.com",
        "user": "1001",
        "setting": "dashboard.timeWindow",
        "value": {
            "start": "09:00",
            "end": "17:00"
        },
        "updated-datetime": "2026-10-01T14:30:00+00:00"
    },
    {
        "domain": "example.com",
        "user": "1001",
        "setting": "notifications.enabled",
        "value": true,
        "updated-datetime": "2026-09-30T19:05:00+00:00"
    },
    {
        "domain": "example.com",
        "user": "1001",
        "setting": "theme",
        "value": "dark",
        "updated-datetime": "2026-09-28T08:15:00+00:00"
    }
]

Modified at 2026-10-09 00:58:30

List domain speech word names

Create or update user setting