GET/v1/table-preferences/{tableKey}

Read table-preferences tableKey

One grid's layout as the signed-in person arranged it — tableKey namespaced like table:deals:overview — with its column order, hidden columns, sort column and direction, and grouping column. Typed, unlike the opaque blob get_preferences_key answers, so the column ids in it can be reasoned about. put_table-preferences_tableKey replaces it whole.

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.

tableKeypath · stringrequired

bodyquery · nulloptional

paramsquery · objectoptional

:tableKeystringoptional

queryquery · objectoptional

Responses

200application/json

the action's answer

{
  "data": {
    "columnOrder": [
      "string"
    ],
    "groupColumn": "string",
    "hiddenColumns": [
      "string"
    ],
    "sortColumn": "string",
    "sortDirection": "string",
    "tableKey": "string",
    "updatedAt": "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