Skip to main content
GET
← Files Read which tabs a workbook has before opening its import session. Only reads: nothing is scheduled and nothing changes. A CSV has no tabs, so sheets is empty.
Beta. Part of the Import API, in beta. The contract may still change before general availability.

Request

Path Parameters

string
required
The file’s id.

Query Parameters

string
The template to read the selector’s answer for. Without it, the one the file was classified in.

Headers

string
required
Your API key.
string
required
The organization that owns the file.

Response

array
One entry per tab: name, rows (non-empty rows under its header) and date_min and date_max (the first and last dates of its column with the most dates). All but name are null for a tab that was not profiled: past the limit of tabs or of time, or unreadable.
object
The sheet selector’s answer, a suggestion: state (pending, decided, abstained, skipped, failed), main_sheet, sheets, confidence and source. Null when there is none for this file and template: a CSV, an .xls, no template, or the selector not being on for your organization. While pending, read it again.

Errors

Errors are problem details. 404 NOT_FOUND, 400 IMPORT_FILE_TYPE_NOT_SUPPORTED (not a spreadsheet), 400 IMPORT_FILE_TOO_LARGE, 422 FILE_NOT_IMPORTABLE, 503 IMPORT_HEAVY_OPERATION_BUSY, and 429 beyond the rate limits. A workbook’s tabs are read once: asking again answers the same tabs without reading the file again.

Open an Import Session

Import the tab you choose

Get a File (v2)

The file’s state