---
title: "GET /api/database/views/grid/{slug}/public/group-by-data/"
method: GET
path: "/api/database/views/grid/{slug}/public/group-by-data/"
tags: ["Database table grid view"]
---

# GET /api/database/views/grid/{slug}/public/group-by-data/

`GET /api/database/views/grid/{slug}/public/group-by-data/`

## Path parameters

- `slug` string, required

## Query parameters

- `aggregations_only` boolean
- `depth` integer
- `descendant_limit` integer
- `descendant_row_budget` integer
- `filter__{field}__{filter}` string
- `filter_type` string
- `filters` string
- `group_by` string
- `include_descendants` boolean
- `include_totals` boolean
- `limit` integer
- `offset` integer
- `parents` string
- `search` string
- `search_mode` string

## Response `200`

- GridViewGroupByData
  - `pages` GridViewGroupByDataPage[], required
    - `parent` object, required — The serialized parent group path requested for this page.
    - `groups` GridViewGroupByDataGroup[], required
      - `path` object, required — Mapping of group-by field db_column names to the serialized group value at every depth from 0 up to this group's depth.
      - `display` object — Mapping of group-by field db_column names to the renderable display value for reference fields (for example collaborator names or the linked row's primary value). Only present for fields whose group value is an id or list of ids that the client cannot render on its own.
      - `depth` integer, required — Zero-based depth of this group in the group-by hierarchy.
      - `row_count` integer — Number of leaf rows descending from this group. In `aggregations_only` mode, this is still returned so derived aggregation values can be formatted without using optimistic client-side counts.
      - `children_count` integer — Number of immediate sub-groups. Omitted at leaf depth.
      - `sibling_index` integer — Zero-based index of this group among its siblings. Omitted in `aggregations_only` mode, which returns no windowed layout.
      - `row_offset` integer — Absolute offset of this group's first descendant row in the full grouped row order. Omitted in `aggregations_only` mode, which returns no windowed layout.
      - `aggregations` object — Per-group aggregation values keyed by field db_column, mirroring the grid view field-aggregations response. Only present for visible fields that have a scalar aggregation configured.
    - `offset` integer, required
    - `limit` integer, required
    - `group_count` integer, required
  - `truncated` boolean — Whether descendant loading stopped early because the response page or group cap was reached.
  - `aggregations` object — Table-level field aggregation totals keyed by field db_column, mirroring the grid view field-aggregations response. Only present when `include_totals=true` was requested.

## Other responses

- `400`
- `401`
- `404`

---

[API](https://skmtc.net/baserow/apis/baserow-api-spec.md) · [All operations](https://skmtc.net/baserow/apis/baserow-api-spec/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/baserow/baserow-api-spec/versions/0c490e5b0c7f/schema)