Skip to content

GetSettings

Returns all custom settings for an account. The response data object maps each setting key to its JSON value, preserving boolean values. An account without settings returns an empty object.

The TCP request envelope contains command, extID, and data.

Request Fields

Name Type Required Description
command string Yes Must be GetSettings.
extID string Yes Request identifier echoed in the response.
data.login integer Yes Account login. Required even when a user session reads its authenticated login.
__token string For an authenticated session JWT session token, supplied at the request-envelope level.

For a user session, the server reads the login in the authenticated session. Customer and staff sessions use data.login. Staff sessions require access_backoffice and set_accounts; a SuperAdmin bypasses these staff scope and permission checks.

Request Example

{
  "command": "GetSettings",
  "extID": "settings-1",
  "__token": "<JWT_TOKEN>",
  "data": {
    "login": 7777864
  }
}

Success Response

The response envelope echoes extID, includes the command status, and places the settings object in data.

{
  "extID": "settings-1",
  "status": 200,
  "data": {
    "themeEnabled": true,
    "soundNotify": false,
    "theme": {
      "type": "light"
    }
  }
}

If there are no settings, data is {}.