---
title: "Start a bulk export"
method: POST
path: "/v1/exports"
tags: ["Exports"]
---

# Start a bulk export

`POST /v1/exports`

## Request

- Base URL: `https://api.slashy.com`
- URL: `https://api.slashy.com/v1/exports`
- Auth: HTTP bearer

Start writing Parquet files of the key's mail: one file per inbox, one row per message, with the same fields and rules as `/v1/threads` (never drafts; subjects, snippets, attachment file names and ids, to-do summaries and full text and HTML bodies only with `mail.content.read`). Poll `GET /v1/exports/{id}` until `status` is `succeeded`, then download the files. A team runs one export at a time (`export_in_progress` otherwise). See the guide for the file columns.

**Scope:** `mail.metadata.read`. **Rate limit class:** `export` (10/hour per key).

## Request body

- ExportRequest: Every field is optional; the body itself may be omitted.
  - `inbox_ids` string[]: Export only these inboxes. Default: every inbox the key can read.
  - `since` string, date-time: Only messages that arrived in the inbox at or after this time (`received_at`). Default: everything. A time without an offset is UTC; may not be in the future.

## Response `202`

Accepted

- ExportStarted
  - `id` string, uuid, required
  - `status` 'queued', required

## Other responses

- `401`: Missing, malformed, unknown, revoked or expired API key. `error` is one of: `invalid_api_key`, `api_key_revoked`, `api_key_expired`.
- `403`: The key is valid but may not make this call. `error` is one of: `browser_not_allowed`, `ip_not_allowed`, `not_enterprise`, `key_owner_inactive`, `insufficient_scope`, `no_readable_inboxes`.
- `404`: Not found, or not readable by this key (the two look the same). `error` is one of: `inbox_not_found`.
- `409`: Conflicts with the team's current state. `error` is one of: `export_in_progress`.
- `422`: A parameter is missing or invalid. The body lists each problem (not the `Error` shape).
- `429`: Too many requests. Wait `Retry-After` seconds, then retry. `error` is one of: `too_many_auth_failures`, `rate_limited`, `too_many_concurrent_requests`.
- `503`: Temporarily unavailable. Retry the same request later. `error` is one of: `export_unavailable`.

---

[API](https://skmtc.dev/slashy/apis/slashy-enterprise-api.md) - [All operations](https://skmtc.dev/slashy/apis/slashy-enterprise-api/llms.txt) - [OpenAPI document](https://skmtc.dev/slashy/apis/slashy-enterprise-api/revisions/49841c75ad9f?raw)
