v1

latestOpenAPI 3.1.02026-08-04222461539.5 KB
sheets

Download records as a CSV file

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

get/sheets/{sheetId}/download

Path parameters

sheetIdstring required

Sheet ID

ID of sheet

Query parameters

versionIdstring

Deprecated, use sinceCommitId instead.

commitIdstring

Commit ID

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

sinceVersionIdstring

Version ID

Deprecated, use sinceCommitId instead.

sinceCommitIdstring

Commit ID

Returns records that were changed in that version in addition to any records from versions after that version.

sortFieldstring

Name of field by which to sort records

The field to sort the data on.

sortDirection'asc' | 'desc'

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

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

filter'valid' | 'error' | 'all' | 'none'

Options to filter records

Options to filter records

filterFieldstring

Use this to narrow the valid/error filter results to a specific field

The field to filter the data on.

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

The value to search for data on.

searchFieldstring

Use this to narrow the searchValue results to a specific field

The field to search for data on.

idsstring

Record ID

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

Headers

Authorizationstring required

Bearer authentication

X-Disable-Hooks'true' required

Response

Response with status 200