Skip to content

Get current user's preferences

GET
/v1/users/me/preferences
curl --request GET \
--url https://example.com/v1/users/me/preferences \
--header 'Authorization: Bearer <token>' \
--header 'X-Tenant-ID: 2489E9AD-2EE2-8E00-8EC9-32D5F69181C0'
X-Tenant-ID
required
string format: uuid

Tenant identifier. Must match the tenant associated with the credential. Returns 403 tenant_mismatch if the credential and header belong to different tenants.

OK

Media type application/json
object
locale
required

User locale preference, or null if using tenant default.

string
nullable
timezone
required

IANA timezone ID, or null if using browser detection.

string
nullable
date_format
required

Preferred date display format, or null for locale default.

string
nullable
Allowed values: YYYY-MM-DD MM/DD/YYYY DD/MM/YYYY
time_format
required

Preferred time display format, or null for locale default.

string
nullable
Allowed values: 12h 24h
Example
{
"date_format": "YYYY-MM-DD",
"time_format": "12h"
}

Unauthenticated

Media type application/json
object
code
required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string
message
required

Human-readable description of the error.

string
details

Optional additional context about the error.

object
key
additional properties
any
notices

Policy notices from determining Cedar rules, if applicable.

Array<string>
Example generated
{
"code": "example",
"message": "example",
"details": {},
"notices": [
"example"
]
}

Forbidden

Media type application/json
object
code
required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string
message
required

Human-readable description of the error.

string
details

Optional additional context about the error.

object
key
additional properties
any
notices

Policy notices from determining Cedar rules, if applicable.

Array<string>
Example generated
{
"code": "example",
"message": "example",
"details": {},
"notices": [
"example"
]
}