GET
/api/database/rows/table/{table_id}/List rows in a database table
Lists rows from a database table the authenticated user can access, with each row's values determined by the table's fields. Use search, filters, and order_by to refine results, and include or exclude to control which fields appear. Use page and size to paginate the results.
table_idintegerrequired
The unique identifier of the table whose rows you want to list.
excludestringoptional
Comma-separated field IDs to omit from each row, or field names when `user_field_names` is enabled. All fields are included by default; quote names containing commas and escape names containing double quotes.
filter__{field}__{filter}stringoptional
Applies a filter to a field using the field identifier or name and a supported filter operator, such as `equal`, `contains`, or `higher_than`. You can provide multiple filters; this parameter is ignored when `filters` is provided.
filter_typestringoptional
Combines multiple `filter__{field}__{filter}` filters using `AND` or `OR`. This parameter is ignored when `filters` is provided.
filtersstringoptional
A JSON-serialized filter tree; its `field` value must be a field ID or, when `user_field_names` is enabled, a field name. When provided, this takes precedence over `filter__{field}__{filter}` and `filter_type`.
includestringoptional
Comma-separated field IDs to include in each row, or field names when `user_field_names` is enabled. All fields are included by default; quote names containing commas and escape names containing double quotes.
order_bystringoptional
Comma-separated field IDs or field names to sort rows by. Prefix a field with `-` for descending order; ordering is ascending by default.
pageintegeroptional
The page number of rows to return.
searchstringoptional
Returns only rows with data matching this search query.
search_modestringoptional
Controls search behavior: `FT_WITH_COUNT` uses full-text search, while `COMPAT` searches each cell for the exact term, including whitespace. Defaults to `FT_WITH_COUNT` when omitted.
sizeintegeroptional
The number of rows to return per page.
user_field_namesbooleanoptional
When enabled with a truthy value such as `y`, `yes`, `true`, `t`, `on`, `1`, or an empty value, uses user-defined field names instead of internal names such as `field_123`.
view_idintegeroptional
Applies the filters and sorts configured for the specified view.
{link_row_field}__join={target_field},{target_field2}stringoptional
Looks up values from a target table through an existing link-row field. Name the link-row field and the target fields to retrieve; the link-row field must be included when using `include` or `exclude`.
200Returns a paginated response containing the total result count, links to the next and previous pages, and an array of row objects.
countintegerrequired
The total amount of results.
nextstringrequired
URL to the next page.
previousstringrequired
URL to the previous page.
resultsarray<object>required
400Returned when a filter, sort field, or other query value fails validation.
detailstringoptional
Human readable details about what went wrong.
errorstringoptional
Machine readable error indicating what went wrong.
401Returned when the authenticated user does not have permission to access the table.
detailstringoptional
Human readable details about what went wrong.
errorstringoptional
Machine readable error indicating what went wrong.
404Returned when the table, field, or view identified by the request 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 a filter, sort field, or other query value fails validation. A 401 is returned when the authenticated user does not have permission to access the table. A 404 is returned when the table, field, or view identified by the request does not exist.