v1

latestOpenAPI 3.1.02026-08-04222461539.5 KB

sheets

Get record cells by field

Returns record cell values grouped by all fields in the sheet

get/sheets/{sheetId}/cells

Path parameters

sheetIdstring required

Sheet ID

ID of sheet

Query parameters

fieldKeystring

Returns results from the given field only. Otherwise all field cells are returned

sortFieldstring

Name of field by which to sort records

sortDirection'asc' | 'desc'

Sort direction - asc (ascending) or desc (descending)

filter'valid' | 'error' | 'all' | 'none'

Options to filter records

filterFieldstring

Use this to narrow the valid/error filter results to a specific field

Name of field by which to filter records

pageSizeinteger

Number of logs to return in a page (default 20)

Number of records to return in a page (default 1000 if pageNumber included)

pageNumberinteger

Based on pageSize, which page of records to return

distinctboolean required

When true, excludes duplicate values

Must be set to true

includeCountsboolean

When both distinct and includeCounts are true, the count of distinct field values will be returned

searchValuestring

Search 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 ("")

A value to find for a given field in a sheet. Wrap the value in "" for exact match

qstring

An FFQL query used to filter the records to be queried

Headers

Authorizationstring required

Bearer authentication

X-Disable-Hooks'true' required

Response

Response with status 200

dataTypeSheetsCellsResponseData required

Cell values grouped by field key