Hanzo
OpenapiPref

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

Addresshttps://api.hanzo.ai/v1/pref
MethodGET
Operationget_pref
AuthAuthorization: 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

StatusBodyMeaning
200prefsViewok

200 body — 2 fields.

FieldInTypeAlwaysDescription
prefsbodyanyPrefs is the caller's preference document: an opaque JSON object whose keys the surfaces own, returned verbatim.
updatedAtbodyintegerUpdatedAt is when the document was last written, unix seconds.

Failure carries the platform error shape — see Errors.

Examples

hanzo prefs get

Pref API · All Hanzo APIs · Interactive reference

How is this guide?

On this page