Get My Display Preferences
GET/api/me/preferences
Returns the authenticated user's display preferences in the current account. Users who have never saved a preference get the defaults.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Authentication: Requires Bearer token. Any authenticated user can read their own preferences.
Fields:
show_internal_ids(boolean, defaultfalse) — whether internal record IDs are shown in lists and on detail pages. Exports always include IDs regardless of this setting.
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.