Skip to main content
POST
List records

Pagination

Use hasMore to determine if additional pages exist. Increment offset by limit for each subsequent request. To return only some fields, pass fields with a list of field names or IDs (for example "fields": ["Name", "Status"]).

Sorting

When no sort parameter is provided, records are returned in ascending order by creation time (createdAt ASC).
fieldId is also accepted for backward compatibility, but field is preferred. For a single ascending sort you can pass the field name as a string ("sort": "Name").

Filtering

Use the filter parameter to query records. Each condition takes a field (name or ID) and exactly one operator. Filters support nested AND/OR logic, up to 20 levels deep. A condition on a field that doesn’t exist is ignored rather than rejected, so check field names if a filter returns every record.
Use and or or to combine multiple conditions:
Filters can be nested for complex logic:
Text operators are case-sensitive. Add "mode": "insensitive" to a condition to ignore case, for example { "field": "Email", "equals": "ann@example.com", "mode": "insensitive" }.
autonumber doesn’t support is_empty or is_not_empty. rollup and source fields can’t be filtered, and a lookup can only be filtered (as a checkbox) when it looks up a checkbox.
Filter by single select:
Filter by number range:
Filter by date:
Filter by multiple values:
Filter for empty/non-empty:

Authorizations

Authorization
string
header
required

Enter your Zite API key. Format: Bearer <api_key>

Path Parameters

databaseId
string
required

The unique identifier of the database

tableId
string
required

The unique identifier of the table.

Body

application/json
limit
integer
default:500

Number of records to return (default: 500, max: 2000)

Required range: 1 <= x <= 2000
offset
integer
default:0

Integer-based offset - Number of records to skip for pagination

Required range: x >= 0
sort

A field name to sort ascending by, or an array of sort objects. When not provided, records are returned in ascending order by creation time (createdAt ASC). All queries include an internal tie-breaker to ensure deterministic ordering across paginated requests.

filter
object

Filter condition to query records. Supports nested AND/OR logic. Each condition requires field (field ID or name) and exactly one operator. See Filtering for details.

Example:
fields
string[]

Optional list of field names or IDs to return. Omit to return every field.

Response

List of records

records
object[]
required

Array of records

total
integer
required

Total number of records matching the query

hasMore
boolean
required

Whether there are more records available beyond this page