List entries
List
Returns the entries of the given list, 100 per page ordered by creation date ascending unless sort_by_key and sort_order say otherwise, with take capped at 10000 and take multiplied by page not allowed to exceed 10000.
Aggregations are built automatically from whichever fields the filter touched, and pagination.item_count_total is the list's overall entry count rather than the filtered one.
GET
/api/{tenant:minlength(2)}/v{version:apiVersion}/list_entries/{list_id}
- Authorisation
- Minimum role: USER
Request arguments
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
