API ReferenceSheets

Get record cells by field

Returns record cell values grouped by all fields in the sheet

Path parameters

sheetIdstringRequired
ID of sheet

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

X-Disable-Hooks"true"Required

Query parameters

fieldKeystringOptional
Returns results from the given field only. Otherwise all field cells are returned
sortFieldstringOptional
Name of field by which to sort records
sortDirectionenumOptional

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

Allowed values:
filterenumOptional
Options to filter records
Allowed values:
filterFieldstringOptional
Name of field by which to filter records
pageSizeintegerOptional

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

pageNumberintegerOptional
Based on pageSize, which page of records to return
distinctbooleanRequired
Must be set to true
includeCountsbooleanOptional
When both distinct and includeCounts are true, the count of distinct field values will be returned
searchValuestringOptional
A value to find for a given field in a sheet. Wrap the value in "" for exact match
qstringOptional
An FFQL query used to filter the records to be queried

Response

This endpoint returns an object.
datamap from strings to lists of objects
Cell values grouped by field key