1. Docs
  2. API Reference
  3. Get the admin's preferences

Get the admin's preferences

GET/portal/v1/me/preferences

Returns the calling admin's UI preferences, currently the ui_hints_dismissed map of dismissed hint keys → true. Preferences are user-scoped (no Account or Application in the path) and back the dashboard's persistent UI state. When the user has never set a preference no row is created; an empty preferences shape is returned instead.

Authentication

Bearer TokenAuthorization

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

Responses

application/json

  • dataUserPreferencesResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Returned object

UserPreferencesResponseDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/portal/v1/me/preferences" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
{
  "data": {
    "ui_hints_dismissed": {
      "applications_intro": true,
      "access_control_intro": true
    }
  }
}
 Related endpoints
PATCHUpdate the admin's preferences
 Was this page helpful?

Tell us how we can improve this guide.

Canopy