List entries
List grouped
Returns the list's entries bucketed into the cells formed by swimlane_key and column_key (at least one is required, and each must resolve to a whole number, boolean or single-select property), holding at most 50 entries per cell when one key is given and 10 when both are, with each cell also reporting its true total.
A combination producing more than 500 cells is refused, and unlike the flat list this call writes: entries with no manual sort key yet for the chosen swimlane and column combination get one assigned and stored.
GET
/api/{tenant:minlength(2)}/v{version:apiVersion}/list_entries/{list_id}/grouped
- Authorisation
- Minimum role: USER
Request arguments
| Name |
Type |
Source |
| list_id | Int32 | |
| swimlane_key | String | |
| column_key | String | |
| filter | DTO_standard_filter | Query |
Request body example
Response
- Status
- 200 (OK)
- Type
- DTO_list_entry
- Wrapper
- DTO_response_wrap_get_many
- Other statuses
- 400 (BadRequest), 403 (Forbidden)
Response body example
DTO_standard_filter
| Name | Type | ReadOnly | Description |
|---|
| sort_by_key | String | | Sort by key |
| response_field_keys | String[] | | Only return the fields specified |
| filters | String[] | | Each string needs to be structured: filters=field_key:operator:value1|value2|value3
Only used to store filters for passing along as querystring |
| include_aggregations | Boolean | | Include aggregations |
| include_imported | Boolean | | Include imported |
| search | String | | Search |
| sort_order | ENUM sort_order | | Sort order |
| take | Int32 | | Take |
| page | Int32 | | Page |
DTO_list_entry
| Name | Type | ReadOnly | Description |
|---|
| id | Int32 | ReadOnly | Id |
| created | DateTime | ReadOnly | Created |
| created_by | DTO_reference_user | ReadOnly | Created by |
| last_updated | DateTime | ReadOnly | Last updated |
| last_updated_by | DTO_reference_user | ReadOnly | Last updated by |
DTO_reference_user
| Name | Type | ReadOnly | Description |
|---|
| profile_pic | String | ReadOnly | Profile pic |
| email | String | ReadOnly | Email |
| id | Int32 | | Id |
| label | Object | ReadOnly | Label |
ENUM sort_order
| Value | Name | Description |
|---|
| 0 | ASC | ASC |
| 1 | DESC | DESC |
Generated Aug 4, 2026 18:37
