authenticated
user-preferences

Read User Preferences

Every preference resolved for the caller, definition defaults included.

Returns defaults for keys the person has never set, so the client renders from one payload instead of duplicating the default table.

get/user-preferences

Request

  • Base URL
    https://api-docs.upsmith.com (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Query parameters

category'availability' | 'dispatch' | 'agent' | 'voice' | 'notification' | 'general'

Headers

organization-idstring nullable
x-user-idstring nullable
timezonestring
x-actor-emailstring nullable
x-request-sourcestring nullable
x-operation-idstring nullable
x-commit-messagestring nullable
x-confirmation-idstring nullable
x-chat-idstring nullable

Response

Successful Response

object required

Changes

No recorded changes to this operation across all 1 revision of this API.