Developer docs menu

User preferences API

3 endpoints. Scopes: Scalar360.user-preferences.READ, .CREATE, .UPDATE, .DELETE or .ALL. All calls need Authorization: Scalar360-oauthtoken <access_token> — see Authentication.

GET

Get

/api/v1/user-preferences/navigation

Scope: Scalar360.user-preferences.READ

Example request

curl -X GET "https://api.scalar360.com/api/v1/user-preferences/navigation" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

PUT

Save

/api/v1/user-preferences/navigation

Scope: Scalar360.user-preferences.UPDATE

Body field	Type	Required	Notes
`hiddenModules`	array of string	Yes	required
`moduleTabs`	map of array of string	Yes	required
`accessibility`	object
`accessibility.showQuickActions`	boolean
`accessibility.showBottomNav`	boolean
`accessibility.reduceMotion`	boolean
`accessibility.unifiedSidebar`	boolean
`accessibility.unifiedSidebarTheme`	string
`accessibility.sidebarColor`	string
`accessibility.sidebarCustomColor`	string

Example request

curl -X PUT "https://api.scalar360.com/api/v1/user-preferences/navigation" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"hiddenModules":["string"],"moduleTabs":{},"accessibility":{"showQuickActions":true,"showBottomNav":true,"reduceMotion":true,"unifiedSidebar":true,"unifiedSidebarTheme":"string","sidebarColor":"string"}}'

DELETE

Reset

/api/v1/user-preferences/navigation

Scope: Scalar360.user-preferences.DELETE

Example request

curl -X DELETE "https://api.scalar360.com/api/v1/user-preferences/navigation" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"