Sheets

Download records as a CSV file

GET
Returns records from a sheet in a workbook as a csv file

Path parameters

sheetIdstringRequired
ID of sheet

Query parameters

versionIdstringOptionalDeprecated

Deprecated, use sinceCommitId instead.

commitIdstringOptional
Returns records that were changed in that version in that version and only those records.
sinceVersionIdstringOptionalDeprecated

Deprecated, use sinceCommitId instead.

sinceCommitIdstringOptional
Returns records that were changed in that version in addition to any records from versions after that version.
sortFieldstringOptional
The field to sort the data on.
sortDirectionenumOptional
Sort direction - asc (ascending) or desc (descending)
Allowed values: ascdesc
filterenumOptional
Options to filter records
Allowed values: validerrorallnone
filterFieldstringOptional
The field to filter the data on.
searchValuestringOptional
The value to search for data on.
searchFieldstringOptional
The field to search for data on.
idsstringOptional
The Record Ids param (ids) is a list of record ids that can be passed to several record endpoints allowing the user to identify specific records to INCLUDE in the query, or specific records to EXCLUDE, depending on whether or not filters are being applied. When passing a query param that filters the record dataset, such as 'searchValue', or a 'filter' of 'valid' | 'error' | 'all', the 'ids' param will EXCLUDE those records from the filtered results. For basic queries that do not filter the dataset, passing record ids in the 'ids' param will limit the dataset to INCLUDE just those specific records

Response

This endpoint returns a file.
GET
$curl -G https://api.x.flatfile.com/v1/sheets/%3AsheetId/download \
>     -H "X-Disable-Hooks: true" \
>     -H "Authorization: Bearer <token>" \
>     -d versionId=string \
>     -d commitId=string
Built with