User and Org Preferences API

Keys:

  • theme - One of: light, dark, or an empty string for the default theme
  • homeDashboardId - The numerical :id of a favorited dashboard, default: 0
  • timezone - One of: utc, browser, or an empty string for the defaultOmitting a key will cause the current value to be replaced with the system default value.

Get Current User Prefs

GET /api/user/preferences

Example Request:

  1. GET /api/user/preferences HTTP/1.1
  2. Accept: application/json
  3. Content-Type: application/json
  4. Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Example Response:

  1. HTTP/1.1 200
  2. Content-Type: application/json
  4. {"theme":"","homeDashboardId":0,"timezone":""}

Update Current User Prefs

PUT /api/user/preferences

Example Request:

  1. PUT /api/user/preferences HTTP/1.1
  2. Accept: application/json
  3. Content-Type: application/json
  4. Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
  6. {
  7.   "theme": "",
  8.   "homeDashboardId":0,
  9.   "timezone":"utc"
  10. }

Example Response:

  1. HTTP/1.1 200
  2. Content-Type: text/plain; charset=utf-8
  4. {"message":"Preferences updated"}

Get Current Org Prefs

GET /api/org/preferences

Example Request:

  1. GET /api/org/preferences HTTP/1.1
  2. Accept: application/json
  3. Content-Type: application/json
  4. Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Example Response:

  1. HTTP/1.1 200
  2. Content-Type: application/json
  4. {"theme":"","homeDashboardId":0,"timezone":""}

Update Current Org Prefs

PUT /api/org/preferences

Example Request:

  1. PUT /api/org/preferences HTTP/1.1
  2. Accept: application/json
  3. Content-Type: application/json
  4. Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
  6. {
  7.   "theme": "",
  8.   "homeDashboardId":0,
  9.   "timezone":"utc"
  10. }

Example Response:

  1. HTTP/1.1 200
  2. Content-Type: text/plain; charset=utf-8
  4. {"message":"Preferences updated"}