GET
/api/database/views/grid/{view_id}/List rows in a database table grid view
Lists rows from the table associated with a grid view, applying the view's filters and sortings by default. Use the query parameters to filter, search, sort, group, select fields, or choose either limit/offset or page/size pagination. For field definitions, use the database table fields endpoint; for the view's applied filters and sortings, use the corresponding view filter and sorting endpoints.
view_idintegerrequired
The unique integer identifier of the grid view whose table rows to list.
countbooleanoptional
If true, return only the result count.
exclude_countbooleanoptional
If true, omit the count, previous, and next properties from the response.
exclude_fieldsstringoptional
Comma-separated field identifiers to exclude from the response; all fields are included by default.
filter__{field}__{filter}stringoptional
Filter rows by a field, filter operation, and value, for example `filter__field_1__equal=test`. Multiple filters can be supplied; supported operations depend on the field type. Ignored when `filters` is supplied.
filter_typestringoptional
Combines multiple `filter__{field}__{filter}` filters using `AND` or `OR`; applies only when at least two filters are supplied and is ignored when `filters` is supplied.
filtersstringoptional
JSON-serialized filter tree to apply. The `field` in each filter must be a field identifier, or a field name when `user_field_names` is true. Overrides `filter__{field}__{filter}` and `filter_type` parameters and the view's saved filters.
group_bystringoptional
Comma-separated field identifiers to group rows by; prefix a field with `-` for descending order. Group-by ordering replaces regular sort ordering for those fields.
includestringoptional
Comma-separated response additions: `field_options` and/or `row_metadata`.
include_fieldsstringoptional
Comma-separated field identifiers to include; all fields are included by default.
limitintegeroptional
Maximum number of rows to return. Use with `offset`; cannot be combined with `page`.
limit_linked_itemsintegeroptional
Maximum number of relationships returned per link-row field. All relationships are returned by default.
offsetintegeroptional
Starting row offset. Use only with `limit`.
order_bystringoptional
Comma-separated field identifiers to sort rows by; prefix a field with `-` for descending order.
pageintegeroptional
Page number of rows to return. Use with `size`; cannot be combined with `limit`.
searchstringoptional
Return only rows containing data that matches the search query.
search_modestringoptional
Search behavior: `FT_WITH_COUNT` uses PostgreSQL full-text search, while `COMPAT` performs exact legacy matching including whitespace. Defaults to `FT_WITH_COUNT` when omitted.
sizeintegeroptional
Number of rows to return per page. Use only with `page`.
200Returns a paginated response containing row objects in `results`, the total result `count`, and `next` and `previous` page URLs. The response can also include `field_options` and `row_metadata` when requested.
countintegerrequired
The total amount of results.
field_optionsobjectoptional
An object containing the field id as key and the properties related to view as value.
nextstringrequired
URL to the next page.
previousstringrequired
URL to the previous page.
resultsarray<object>required
row_metadataobjectoptional
An object keyed by row id with a value being an object containing additional metadata about that row. A row might not have metadata and will not be present as a key if so.
400Returned when an ordering, filter, or grouping parameter is invalid, references a missing or unsupported field, or contains an invalid filter tree.
detailstringoptional
Human readable details about what went wrong.
errorstringoptional
Machine readable error indicating what went wrong.
404Returned when the grid view or a referenced field does not exist.
detailstringoptional
Human readable details about what went wrong.
errorstringoptional
Machine readable error indicating what went wrong.
Error handling
A 400 is returned when filter, ordering, or grouping parameters are invalid or refer to unsupported fields or operations; provide supported filter fields and operators, and a valid JSON filters tree if using that parameter. A 404 is returned when the view_id does not identify an existing grid view or a referenced field does not exist. Use either page or limit, not both; offset requires limit, and size requires page.