---
title: "workspaceTableGrouping"
url: https://developers.dagio.ai/reference/workspace-table-grouping/
---

# workspaceTableGrouping

   
                               
                                                                                 
                                          
                  
           
          
   

This reference describes the full structure of `workspaceTableGrouping`. Paths include nested objects, list items and conditional branches. A branch selected by `kind`, `contract` or `mode` only admits its own properties.

## Structure and values

| Field | Options / expected values | Description |
| --- | --- | --- |
| `contract` | `"WorkspaceTableGrouping@1"` | **Required.** Exact discriminant of this contract variant. Match the literal value shown. |
| `options` | `Array<closed object>; min length 1; max length 20` | **Required.** Suggested and admitted values for a declared choice. |
| `options[].key` | `string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u` | **Required.** Stable semantic identifier used by references; changing it changes identity. |
| `options[].label` | `string; min length 1; max length 4000` | **Required.** Human-readable label displayed in the interface. |
| `options[].columnKey` | `string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u` | **Required.** Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
| `initialOptionKey` | `string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u; null` | **Required.** Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility. |
| `maximumGroups` | `integer; ≥ 1; ≤ 100` | **Required.** Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema. |

## Reading the contract

A path ending in `[]` describes each list item; `{key}` describes each dictionary value. The `↻` marker refers to the same recursive expression. Closed objects reject additional properties. Semantic validation denotes an additional check: matching a type does not make a reference, permission or transition valid. References must resolve in the Model and the current user context.

An older variant cannot accept properties belonging to a newer variant. The compiler checks the version and consistency of the complete Model.

## Structural example

This fragment passes the schema for this section. Its business references must be defined in the enclosing Model.

```json
{
  "contract": "WorkspaceTableGrouping@1",
  "options": [
    {
      "key": "client",
      "label": "client",
      "columnKey": "client"
    }
  ],
  "initialOptionKey": null,
  "maximumGroups": 1
}
```

## Related references

[Complete Model index](https://developers.dagio.ai/reference/) · [Build a Model](https://developers.dagio.ai/models/)

<!-- surface-examples:start -->

## Applied examples : Collection columns and formats

Declare each column source before its format, order and filters.

### Configuration

Contract object `workspaceTableGrouping`. [Properties and accepted values](https://developers.dagio.ai/reference/workspace-table-grouping/).

```json
{
  "contract": "WorkspaceTableGrouping@1",
  "options": [
    {
      "key": "client",
      "label": "client",
      "columnKey": "client"
    }
  ],
  "initialOptionKey": null,
  "maximumGroups": 1
}
```

### Variation and connection

Fragment placed in `presentation.tableViews[].layout`. [Properties and accepted values](https://developers.dagio.ai/reference/workspace-table-layout/).

```json
{
  "contract": "WorkspaceTableLayout@1",
  "grouping": null,
  "columns": [
    {
      "columnKey": "number",
      "visible": true,
      "width": null,
      "frozen": true,
      "format": {
        "kind": "text"
      },
      "headerFilterParameterKey": null
    },
    {
      "columnKey": "status",
      "visible": true,
      "width": null,
      "frozen": false,
      "format": {
        "kind": "badge"
      },
      "headerFilterParameterKey": null
    },
    {
      "columnKey": "amount",
      "visible": true,
      "width": null,
      "frozen": false,
      "format": {
        "kind": "number",
        "maximumFractionDigits": 2
      },
      "headerFilterParameterKey": null
    }
  ],
  "columnGroups": []
}
```

### UI layout example

The illustrative layout below places this configuration in the Clients/Quotes app. Insert each fragment at the stated location, with Field, Query and Action references matching the Model declarations.

1. Number
2. Status
3. Amount
4. Last updated

<!-- surface-examples:end -->