Export

Bulk export data from the system to JSON, JSON Lines, or CSV files.

📄️ Add Export

Creates a new export job for accounts, calendar events, users, tasks, or activities and returns it immediately with `exportId` and `status` (`New`). The export is processed asynchronously. Poll /export/get with the returned `exportId` to check the status, then use /export/download to retrieve the files once completed. Requires the `export:manage` permission; exported records are limited to the teams that permission covers.

📄️ Get Export

Get one export by its ID, including its current status and progress. Returns the same export object as /export/list. Use this to check whether an export you created with /export/add has completed before calling /export/download. Requires the `export:manage` permission for the export. Returns a `NotFound` error when the export does not exist, belongs to another company, or is outside the caller's `export:manage` scope.

📄️ List Exports

Lists exports for the current user's company, most recently updated first, including each export's status and progress. Only exports the caller can manage (`export:manage` permission) are returned. Use /export/get instead when you already have an export ID.

📄️ Download Export

Retrieve pre-signed download URLs for a completed export. Large exports may be split across multiple files (up to 50,000 records each), each with its own URL. `urls` is empty when the export matched no records. File names end in `.json`, `.jsonl`, or `.csv` to match the export format, plus `.gz` when gzip compression is used. Each URL downloads its file as an attachment under that file name. Requires the `export:manage` permission for the export.

📄️ Remove Export

Permanently delete an export record and its associated files. Succeeds without error if the export no longer exists. Requires the `export:manage` permission for the export.