---
title: "Get a mailbox export"
method: GET
path: "/mailboxes/{id}/exports/{export_id}"
tags: ["Mailboxes"]
---

# Get a mailbox export

`GET /mailboxes/{id}/exports/{export_id}`

## Request

- Base URL: `https://shipmail.to/api/v1`
- URL: `https://shipmail.to/api/v1/mailboxes/{id}/exports/{export_id}`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://shipmail.to/api/auth/oauth2/authorize`, token URL `https://shipmail.to/api/auth/oauth2/token`)

Read one customer mailbox export. Completed exports include a private download URL valid for at most five minutes and never beyond the seven-day export expiry.

## Headers

- `X-Shipmail-Organization` string

## Response `200`

Mailbox export status.

- MailboxExport
  - `object` 'mailbox_export', required
  - `id` string, required
  - `mailbox_id` string, required
  - `status` 'pending' | 'processing' | 'completed' | 'failed' | 'expired', required
  - `format` 'zip', required
  - `format_version` integer, required
  - `file_size` integer, nullable, required
  - `message_count` integer, nullable, required
  - `folder_count` integer, nullable, required
  - `error_code` 'source_unavailable' | 'snapshot_changed' | 'export_failed' | 'null', nullable, required
  - `download_url` string, uri, nullable, required
  - `download_url_expires_at` string, date-time, nullable, required
  - `expires_at` string, date-time, nullable, required
  - `created_at` string, date-time, required
  - `started_at` string, date-time, nullable, required
  - `completed_at` string, date-time, nullable, required

## Other responses

- `401`: Authentication failed.
- `403`: Insufficient permissions.
- `404`: Resource not found.
- `422`: Validation failed.
- `429`: Rate limit exceeded.

---

[API](https://skmtc.dev/shipmail/apis/shipmail-api.md) · [All operations](https://skmtc.dev/shipmail/apis/shipmail-api/llms.txt) · [OpenAPI document](https://skmtc.dev/shipmail/apis/shipmail-api/revisions/2c23e59d7e30?raw)