API ReferenceRecords

Get record Indices

Returns indices of records from a sheet in a workbook

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

commitIdstringOptional

Commit ID

sinceCommitIdstringOptional

Commit ID

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

searchValuestringOptional

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

searchFieldstringOptional

Use this to narrow the searchValue results to a specific field

idsstringRequired

List of record IDs to include in the query. Limit 100.

qstringOptional

An FFQL query used to filter the result set

Response

This endpoint returns a list of objects.
idstring
indexinteger

Errors