Skip to main content

letters

This query fetches the letters within a specified DateRange. 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. Requesting body signs each stored image, so omit body from large sync or list pages unless you need the HTML.

letters(
dateRange: DateRange
pagination: Pagination
cursorPagination: CursorPagination
options: QueryOptions
filters: LetterQueryFilters
): LetterData

Arguments​

letters.dateRange ● DateRange input​

letters.pagination ● Pagination input​

letters.cursorPagination ● CursorPagination input​

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

letters.options ● QueryOptions input​

letters.filters ● LetterQueryFilters input​

Type​

LetterData object​

A collection of letters and the related pagination information. With offset pagination, pageInfo is a standard PageInfo. With cursorPagination, pageInfo uses the PageInfoForCursorPagination shape (pageSize and hasMore only; page is unset).