GET/v1/preferences/{key}

Read preferences key

One of the signed-in person's own app preferences by its namespaced key (setting:theme, table:leads) — the stored JSON handed back exactly as it was written, because this service never interprets it. get_preferences lists them and put_preferences_key writes one. A table's column order is deliberately NOT here: that is typed, and lives at get_table-preferences_tableKey.

Access class: workspace.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokensessionoptional

Stored only in this browser for the session security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

keypath · stringrequired

bodyquery · nulloptional

paramsquery · objectoptional

:keystringoptional

queryquery · objectoptional

Responses

200application/json

the action's answer

{
  "data": {
    "key": "string",
    "updatedAt": "string",
    "value": "string"
  }
}

dataoptional

defaultapplication/json

a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

{
  "error": "string"
}

errorstringrequired