Get record cells by field

GET

Returns record cell values grouped by all fields in the sheet

sheetIdstringRequired

ID of sheet

X-Disable-Hooks"true"RequiredDefaults to true

fieldKeystringOptional

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

sortFieldstringOptional

Name of field by which to sort records

sortDirection"asc" or "desc"Optional

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

Allowed values: ascdesc

filterenumOptional

Options to filter records

Allowed values: validerrorallnone

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

This endpoint returns an object.

datamap from strings to lists of objects

Cell values grouped by field key

1	curl -G https://api.x.flatfile.com/v1/sheets/us_sh_YOUR_ID/cells \
2	-H "X-Disable-Hooks: true" \
3	-H "Authorization: Bearer <token>" \
4	-d distinct=true \
5	-d fieldKey=firstName \
6	-d sortField=firstName \
7	-d sortDirection=asc \
8	-d filter=valid