--- title: "Export table rows as a CSV or Excel file" method: POST path: "/tables/{table_id}/export/" tags: ["table-export"] --- # Export table rows as a CSV or Excel file `POST /tables/{table_id}/export/` ## Request - Base URL: `https://api.getoneprofile.ai` (the document declares no server; this is the origin it was published from) - URL: `https://api.getoneprofile.ai/tables/{table_id}/export/` - Auth: one of: - API key in header `X-API-Key` - HTTP bearer Download a table's rows as a file. Two scopes: send `sorts`/`where`/`column_ids` to export what the grid is currently showing, or `record_ids` to export a specific row selection. The two are mutually exclusive. `format` picks the file, and it changes how values are written. A CSV holds everything as text: timestamps in ISO 8601, lists and objects as JSON, so the file round-trips back through an import. Free-text cells are neutralised against spreadsheet formula injection; numbers are not, so they stay summable. An .xlsx keeps native types instead, so a number stays summable, a date sorts as a date and a checkbox is a real boolean. Nothing needs neutralising there, because a string cell is never evaluated as a formula. A CSV streams synchronously in keyset pages, so a large export starts downloading immediately. A workbook is a zip and cannot be streamed, so it is built in full before the response begins. ## Path parameters - `table_id` string, uuid, required ## Request body - TableExportRequestSchema: Request body for a table file export. Two scopes, one body. Send ``sorts``/``where`` to export what the grid is currently showing, in the same vocabulary the rows query accepts, so a filtered view exports exactly the rows the user can see. Send ``record_ids`` to export a specific selection instead. The two are mutually exclusive: an enumerated selection has already answered the question a filter asks. ``column_ids`` is the projection, in display order, so hiding or reordering a column in the grid is reflected in the file. ``format`` picks the file. It defaults to CSV, so a client written before Excel existed keeps working untouched. - `column_ids` string[], nullable: Export these columns, in this order. Omit for every column, in the table's own column order. - `format` 'csv' | 'xlsx': The file a table export is downloaded as. The two differ in more than their extension. A CSV is text, so every value becomes a string and free text is defanged against a spreadsheet reading a leading "=" as a formula. A workbook keeps native types, so a number stays summable and a date sorts as a date, and no defanging is needed because a string cell is never evaluated. - `record_ids` string[], nullable: Export exactly these rows, in display order. Mutually exclusive with `sorts` and `where`. - `sorts` TableRowSortSchema[]: Order rows by these columns instead of the display order. - `column_id` union, required: A column ID, or `__created_at__` / `__updated_at__` to order by when the row was added or last edited. - string, uuid - '__created_at__' | '__updated_at__': The sort keys that order by the ROW rather than by one column's cells. ``CREATED_AT`` is when the row was added; ``UPDATED_AT`` is when any of its cells last changed (the row was added, for one with no cells). They share the sort slot with column IDs, so a query or a saved view names either the same way; the dunder spelling keeps them apart from any UUID. - `direction` 'asc' | 'desc': Which way a sorted row listing runs. - `where` TableRowsWhereSchemaInput: The whole predicate for a rows query. ``items`` mixes conditions with groups under one joiner, so ``A and (B or C)`` is an AND over ``[A, group(OR, [B, C])]``. Send no ``where`` at all rather than an empty one, so "no filter" stays a single state. The cap is on LEAVES, not on items: eight conditions cost eight correlated EXISTS clauses whether they are grouped or not, and it is the clause count that the query planner pays for. - `items` TableRowWhereItemSchemaInput[], required: Conditions and groups. - union - TableRowFilterSchemaInput: One predicate a row must satisfy. Which operators apply depends on the column's type: a range comparison on a checkbox is rejected rather than silently matching nothing. The valueless operators (``is_empty``, ``is_not_empty``, ``is_true``, ``is_false``) must not carry a value. - `column_id` union, required: A column ID, or `__any_column__` to ask about every cell in the row at once. `__any_column__` takes only `has_error` and `has_no_error`. - string, uuid - '__any_column__' | '__record_id__': The filter targets that name the whole ROW rather than one column. ``ANY_COLUMN`` asks a question of every cell in the row at once: "does any column have an error?" is the table-wide half of the per-column ``has_error``. It stands in the ``column_id`` slot of an ordinary condition (the same trick the system sort keys use), so a row-wide question travels through every surface that already carries a predicate tree (a saved view, a run's scope, an export, a count) with nothing to add to any of them. The dunder spelling keeps it apart from any UUID. - `operator` 'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte' | 'contains' | 'not_contains' | 'contains_any_of' | 'not_contains_any_of' | 'starts_with' | 'is_true' | 'is_false' | 'is_empty' | 'is_not_empty' | 'has_error' | 'has_no_error' | 'has_results' | 'has_no_results' | 'has_not_run' | 'is_stale' | 'is_not_stale' | 'run_condition_not_met' | 'run_stopped', required: A row filter predicate. Which operators are legal depends on the column's data type; the service validates the pairing and rejects a mismatch, so an operator here is a vocabulary entry rather than a promise it applies everywhere. Two families live here. The VALUE operators ask about what a cell holds and are keyed off the column's storage slot. The STATE operators ask about what the last run DID to the cell (errored, skipped, never ran, went stale) and are keyed off the column's kind instead: they read the compute metadata that only a computed column ever writes, and mean nothing on a hand-typed one. - `type` 'condition' - `value` union - string - integer - number - boolean - string, date-time - string, date - CellValueInput[] - object - TableRowFilterGroupSchemaInput: A parenthesised run of conditions, joined among themselves. Holds conditions and never groups: one level of nesting is expressible and a second is not, structurally. That covers ``A and (B or C)`` (what a filter panel offers) while keeping the SQL a flat walk. - `conditions` TableRowFilterSchemaInput[], required: The conditions inside the parentheses. - `column_id` union, required: A column ID, or `__any_column__` to ask about every cell in the row at once. `__any_column__` takes only `has_error` and `has_no_error`. - … - `operator` 'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte' | 'contains' | 'not_contains' | 'contains_any_of' | 'not_contains_any_of' | 'starts_with' | 'is_true' | 'is_false' | 'is_empty' | 'is_not_empty' | 'has_error' | 'has_no_error' | 'has_results' | 'has_no_results' | 'has_not_run' | 'is_stale' | 'is_not_stale' | 'run_condition_not_met' | 'run_stopped', required: A row filter predicate. Which operators are legal depends on the column's data type; the service validates the pairing and rejects a mismatch, so an operator here is a vocabulary entry rather than a promise it applies everywhere. Two families live here. The VALUE operators ask about what a cell holds and are keyed off the column's storage slot. The STATE operators ask about what the last run DID to the cell (errored, skipped, never ran, went stale) and are keyed off the column's kind instead: they read the compute metadata that only a computed column ever writes, and mean nothing on a hand-typed one. - `type` 'condition' - `value` union - … - `joiner` 'and' | 'or': How the members of one filter level combine. - `type` 'group' - `joiner` 'and' | 'or': How the members of one filter level combine. ## Response `200` The table as a CSV or Excel file. ## Other responses - `401`: Unauthorized - `403`: Forbidden - `404`: Table not found - `422`: Invalid request made to the API. - `500`: Internal server error. - `502`: Bad gateway error. - `503`: Service unavailable. --- [API](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile.md) · [All operations](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/llms.txt) · [OpenAPI document](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/revisions/4a6bd71e3f02?raw)