Get Settings By Login¶
Returns all custom settings for an account as a JSON object. Values preserve their JSON types, including boolean true and false values saved with Set Setting. If the account has no settings, the response is {}.
GET
https://{some_domain}/settings
Authorization¶
Include the session JWT in the Authorization header:
Authorization: <JWT_TOKEN>
The login query parameter is required for every session. For a normal user session, the server reads the authenticated account login. For customer and staff sessions, it uses the supplied login. Manager, administrator, and dealer sessions need the access_backoffice scope and set_accounts permission; a SuperAdmin bypasses these staff scope and permission checks.
Request¶
Query Parameters¶
| Field | Type | Required | Description |
|---|---|---|---|
login |
integer | Yes | Account login. Required even when a normal user session's authenticated login is used. |
Request example: GET https://{some_domain}/settings?login=7777864.
Response¶
Success (200)¶
The response is a JSON object whose property names are setting keys and whose values are their saved JSON values. Boolean values are returned as JSON booleans.
An account without settings returns:
{}
Error Responses¶
| HTTP | Error | Description |
|---|---|---|
| 400 | INVALID_DATA |
The required login field is missing or invalid. |
| 403 | INVALID_ACCESS |
The target login could not be resolved. |
| 403 | RET_NOT_ENOUGH_RIGHTS |
A manager session lacks the required scope or permission. |
Example response with saved values:
{
"themeEnabled": true,
"soundNotify": false,
"theme": {
"type": "light"
}
}