# 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`.

## Endpoint

`GET /v1/table-preferences/{tableKey}`

## Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| tableKey | path | string | Yes |
| body | query | null | No |
| params | query | object | No |
| query | query | object | No |

## Responses

### 200

the action's answer

Content type: `application/json`.

```json
{
  "data": {
    "columnOrder": [
      "string"
    ],
    "groupColumn": "string",
    "hiddenColumns": [
      "string"
    ],
    "sortColumn": "string",
    "sortDirection": "string",
    "tableKey": "string",
    "updatedAt": "string"
  }
}
```

### default

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.

Content type: `application/json`.

```json
{
  "error": "string"
}
```