v1
latestOpenAPI 3.1.02026-08-04222461539.5 KBrecords
Get record Indices
Returns indices of records from a sheet in a workbook
get/sheets/{sheetId}/records/indices
Path parameters
sheetIdstring required
Sheet ID
ID of sheet
Query parameters
commitIdstring
Commit ID
sinceCommitIdstring
Commit ID
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
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 ("")
searchFieldstring
Use this to narrow the searchValue results to a specific field
idsstring required
Record ID
List of record IDs to include in the query. Limit 100.
qstring
An FFQL query used to filter the result set
Headers
Authorizationstring required
Bearer authentication
X-Disable-Hooks'true' required
Response
Response with status 200