Returns the signed-in caller's OWN preference document — the theme, density and…
Returns the signed-in caller's OWN preference document — the theme, density and pinned nav that follow them across every Hanzo surface.
GET /v1/pref
| Address | https://api.hanzo.ai/v1/pref |
| Method | GET |
| Operation | get_pref |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Returns the signed-in caller's OWN preference document — the theme, density and pinned nav that follow them across every Hanzo surface. There is no path to another user's preferences: not for an org admin, not for a platform SuperAdmin, because the subject is built from the validated credential and is the mandatory predicate on the read. A caller who has never saved anything gets an empty document at 200, never a 404, so the user menu always renders.
Request
GET /v1/pref takes no parameters and no body — the credential is the whole request.
Response
| Status | Body | Meaning |
|---|---|---|
200 | prefsView | ok |
200 body — 2 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
prefs | body | any | — | Prefs is the caller's preference document: an opaque JSON object whose keys the surfaces own, returned verbatim. |
updatedAt | body | integer | — | UpdatedAt is when the document was last written, unix seconds. |
Failure carries the platform error shape — see Errors.
Examples
hanzo prefs getimport { Configuration, PrefApi } from 'hanzoai';
const api = new PrefApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getPref();from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import PrefApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = PrefApi(client).get_pref()cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.PrefAPI.GetPref(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, pref_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = pref_api::get_pref(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.PrefApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new PrefApi(client).getPref();The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →
curl https://api.hanzo.ai/v1/pref \
-H "Authorization: Bearer $HANZO_API_KEY"The door reaches pref through the prefs tool, which names its 2 operations with its own verbs — this one among them, under a name only the door declares. describe explains any of them:
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "describe",
"arguments": {
"op": "list_prefs"
}
}
}'How is this guide?