sortFieldstringOptionalName of field by which to sort records
sortDirection"asc" or "desc"OptionalSort direction - asc (ascending) or desc (descending)
Allowed values: ascdesc
filterenumOptionalOptions to filter records
Allowed values: validerrorallnone
filterFieldstringOptionalName of field by which to filter records
searchValuestringOptionalSearch for the given value, returning matching rows. For exact matches, wrap the value in double quotes ("Bob"). To search for null values, send empty double quotes ("")
searchFieldstringOptionalUse this to narrow the searchValue results to a specific field
idsstringOptionalThe Record Ids param (ids) is a list of record ids that can be passed to several record endpoints allowing the user to identify specific records to INCLUDE in the query, or specific records to EXCLUDE, depending on whether or not filters are being applied. When passing a query param that filters the record dataset, such as 'searchValue', or a 'filter' of 'valid' | 'error' | 'all', the 'ids' param will EXCLUDE those records from the filtered results. For basic queries that do not filter the dataset, passing record ids in the 'ids' param will limit the dataset to INCLUDE just those specific records. Maximum of 100 allowed.
pageSizeintegerOptionalNumber of records to return in a page (default 10,000)
pageNumberintegerOptionalBased on pageSize, which page of records to return (Note - numbers start at 1)
includeCountsbooleanOptionalDeprecated
DEPRECATED Use GET /sheets/:sheetId/counts
includeLengthbooleanOptionalThe length of the record result set, returned as counts.total
includeLinksbooleanOptionalIf true, linked records will be included in the results. Defaults to false.
includeMessagesbooleanOptionalInclude error messages, defaults to false.
fieldsstringOptionalA list of field keys to include in the response. If not provided, all fields will be included.
forstringOptionalif "for" is provided, the query parameters will be pulled from the event payload
qstringOptionalAn FFQL query used to filter the result set