Skip to main content
GET
Query records

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

folder
string

Folder ID to filter records by. At least one of folder or space_id must be provided.

space_id
string

Space ID to filter records by. At least one of folder or space_id must be provided.

config_id
string

Comma-separated config IDs to narrow the query. One ID is ANDed with the folder/space filter; multiple IDs form an OR group.

limit
integer

Maximum number of records to return.

offset
integer

Number of records to skip (pagination). At most 10,000; use cursor to read further.

cursor
string

next_cursor from the previous page, passed back unchanged with the same filter and sort_by. Replaces offset: sending both is refused 400, as is a cursor with latest_by. Pages of any depth; rows with equal sort values are neither skipped nor repeated. The sort field must be a declared sortable index field. Answers 501 while the indexer predates cursor paging.

want_cursor
boolean

true on the first page of a cursor walk: the reply then carries next_cursor and no next_offset. Cursor pages order by the index's sort keys; without it the page is ordered and paged exactly as before. Refused 400 with latest_by; answers 501 while the indexer predates cursor paging.

parent_folder
string

Records whose parent_folder equals this; ANDed with folder.

scope_folder
string

Records whose folder OR parent_folder equals this. Satisfies the scope requirement on its own.

under_folder
string

Records in this folder or anywhere below it, at any depth: a folder, or a dotted folder path (read by its last parent.child pair). One indexed term, ANDed with every other parameter. Echoed as under_folder in the reply. Answers 503 until the account's records are indexed with their folder ancestors. Satisfies the scope requirement on its own.

ancestors_unverified
boolean

Staff only, with under_folder: answer before the account's marker is set, so the backfill can check parity. A client is refused 403.

filter
string

JSON {conditions, sort_by} over record and declared index_fields.

sort_by
string

Field name; prefix - for descending. Default created_at.

fields
string

Comma-separated payload paths to keep.

Words ANDed; each matches any search field (text by prefix, keyword exactly). Needs one config_id.

search_fields
string

Comma-separated declared text or keyword index fields; defaults to every declared text field.

date_field
string

created_at, updated_at or a declared date index field.

date_from
string

Inclusive lower bound, RFC3339 or YYYY-MM-DD.

date_to
string

Inclusive upper bound, RFC3339 or YYYY-MM-DD (a bare date covers its whole day).

latest_by
string

JSON {"group_field":"...","order_field":"..."}: keep the row with the highest order_field per group_field value. order_field must be a declared sortable index field. Reads one page of at most 1000 scoped rows, highest order_field first (the index page maximum; no sortable record field is unique, so deeper paging is not used); the reply carries truncated: true when more matched. total_hits counts groups.

Response

Matching records

status_code
integer

HTTP status code echoed in the response body.

body
object

Response payload.