Get the admin's preferences
/portal/v1/me/preferencesAuthentication
- Bearer Token
AuthorizationJWT access token
Code samples
curl -X GET "https://api.canopy.dev/portal/v1/me/preferences" \ -H "Authorization: Bearer $CANOPY_TOKEN"
const response = await fetch("https://api.canopy.dev/portal/v1/me/preferences", {
method: "GET",
headers: {
"Authorization": "Bearer $CANOPY_TOKEN"
},
});
const data = await response.json();import requests
response = requests.get(
"https://api.canopy.dev/portal/v1/me/preferences",
headers={
"Authorization": "Bearer $CANOPY_TOKEN"
},
)
data = response.json()package main
import (
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://api.canopy.dev/portal/v1/me/preferences", nil)
req.Header.Set("Authorization", "Bearer $CANOPY_TOKEN")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
}Responses
200 Returns the admin's persistent UI preferences (dismissed welcome banners, etc.). Missing keys mean the value has never been set; clients should treat them as the default.
{
"ui_hints_dismissed": {
"applications_intro": true,
"access_control_intro": true
}
}application/json
ui_hints_dismissedany objectMap of UI hint keys the user has dismissed. Keys are stable identifiers (e.g. 'applications_intro'); a hint is dismissed when its key maps to true.
401 Invalid or expired token
403 This token is not authorized for this endpoint (wrong principal type — e.g., admin token on identity-only endpoint, or vice versa)