Preferences Operations Get By Key
Returns the stored value of a specific preference key. Accessible to every authenticated role. The path /api/v1/users/preferences/{key} is an alias of /api/v1/user/preferences/{key} for every method. The value is returned as parsed JSON of any type, or as the raw string when it was stored but is not JSON.
Preference key. Free-form: any non-blank name of 1 to 256 characters; the server keeps no allow-list. The console itself uses names such as tabs.
tabs.endpoints
200 OK successful response envelope. The stored value of the key, which can be any JSON value
{
"order": [
"name",
"status"
],
"visibility": {
"name": true,
"status": true
}
}
401 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
404 Not Found: PREFERENCE_NOT_FOUND when the signed-in user has no stored value for the key
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
curl -H 'Authorization: <value>' https://{api_host}/api/v1/user/preferences/{key}