Skip to main content

records

This query fetches a collection of records held in the system. Prefer cursorPagination for large result sets (for example sync/export); deep offset pages remain expensive even with indexes. Existing pagination: { page, pageSize } behaviour is unchanged. Do not provide pagination and cursorPagination together.

records(
  dateRange: DateRange
  pagination: Pagination
  cursorPagination: CursorPagination
  options: QueryOptions
): RecordData

Arguments​

records.dateRange ● DateRange input​

records.pagination ● Pagination input​

records.cursorPagination ● CursorPagination input​

Cursor-based pagination alternative to pagination. Mutually exclusive with pagination. Use the last record's id as cursor for the next page. Results are always ordered by _id ascending for NEXT (and descending then reversed for PREVIOUS).

records.options ● QueryOptions input​

Type​

RecordData object​

Multiple records and information regarding pagination. With offset pagination, pageInfo is a standard PageInfo. With cursorPagination, pageInfo uses the PageInfoForCursorPagination shape (pageSize and hasMore only; page is unset).