OlammaAPI
Menu

List records

Read records through a view, 100 at a time at most. The view’s saved sort and filters apply; add sort, filters, match or q to narrow just this read without changing the view. Calendar views can read a date range instead.

GET/v1/w/{workspace}/tables/{tableId}/records

Path parameters

workspacestringrequired

Your workspace’s address name.

tableIdstringrequired

The table to read.

Query parameters

viewstringrequired

The view to read through, from Get table. Its sort and filters apply.

sortstring

JSON, applied to this read only: {"fieldId":"tf_…","direction":"asc"} or "desc".

filtersstring

JSON list, applied to this read only: [{"fieldId":"tf_…","op":"contains","value":"Ada"}]. Operators depend on the field type; see Working with Tables.

matchstring

JSON text, with quotes: "all" (every filter matches) or "any".

fromstring

Calendar views: first day, YYYY-MM-DD.

tostring

Calendar views: last day, YYYY-MM-DD, at most 42 days after from.

undatedenum

Calendar views: 1 to read records with no date instead.

qstring

Search text across the record’s cells.

cursorstring

The nextCursor from the previous page; leave out for the first page.

limitinteger

Records per page, 1 to 100. Defaults to 100.

Response

recordsobject[]required
nextCursorstring | null
totalnumber
truncatedboolean

Calendar ranges only: more rows matched than the 2,000 returned

untrustedstring[]

Details

Read grid/board/gallery rows (gallery uses newest first without a sort), a calendar range (from/to, inclusive, at most 42 days and 2,000 rows with truncated), or its undated tray (undated=1, up to 50 rows). Follow nextCursor explicitly; config or temporary query changes invalidate it. Optional sort, filters and match are JSON strings validated like saved config, applied only to this read; repeat them on every page. Other people’s personal views return not found.

Since 2026-12. Errors are listed in Errors.