Docmost Octri Preview
POST/bases/rows

List rows in a base

Lists rows in a base with optional filtering, sorting, text search, and pagination. Use filter and up to 5 sorts to shape the results; cursors are valid only for the exact filter and sort settings used to obtain them.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

8 body fields

The base rows to retrieve and optional filters, sorting, search, and pagination settings. pageId is required; references is included in the response even when there is nothing to expand.

filterobjectoptional
A compound filter tree with up to 5 levels of nesting and 50 nodes total.
pageIdstringrequired
Id of the base. A base *is* a page, so this is the base's page id - the same id you would pass to the page endpoints.
sortsarray<object>optional
Sort rules, each specifying a property ID and direction. Accepts at most 5 rules.
adminViewbooleanoptional
If `true`, the list includes all items the admin has global permissions to access by virtue of their admin role.
beforeCursorstringoptional
Set to `prevCursor` from the previous call to list the previous page. Ignored when `cursor` is also supplied.
cursorstringoptional
Set cursor to `nextCursor` returned by the previous call to list items in the next page.
limitintegeroptional
Maximum number of items to return per page.
Default:20
querystringoptional
Optional text filter to search within the listed items (e.g. filter members by name).

4 status codes
200Returns a paginated response containing base rows and references; `references` is present even when empty.
dataobjectoptional
statusintegeroptional
successbooleanoptional
400Returned when the filter or sort configuration is invalid.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional
403Returned when access is forbidden.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional
404Returned when the base is not found.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

A 400 is returned for an invalid filter or sort; limit must be from 1 to 100, sorts accepts at most 5 entries, and the filter tree can nest 5 levels and contain 50 nodes total. A 403 is returned when access is forbidden, and a 404 is returned when the base is not found. pageId is required; start a fresh page instead of reusing a cursor after changing the query.