Search the docs

Find a page, a section, or an endpoint.

Sign inGet started

Export

Every export endpoint, generated from the API's own schemas.

Export mail as mbox

get/api/v1/export

Every message the key can read, as one `application/mbox` file, streamed — or one address of it with `identity_id`. Each message carries `X-Pidgeon-Mailbox` so a file holding several addresses can be split again; originals are byte for byte where storage still holds them. Four an hour per workspace.

Parameters

  • identity_iduuid

Responses

  • 200The mbox.
  • 400The request is not valid. `error.field` names the input at fault when there is one.
  • 401No API key, or one that is not valid.
  • 403Refused. `error.code` says why: `forbidden` when this key may not do this or the account is on hold, `abuse_blocked` when a limit says no.
  • 404No such resource, or one this key cannot reach. The two answer the same, so treat a 404 as “not available to you” rather than “does not exist”.
  • 409It conflicts with what is there: it already exists, or the `etag` you sent is not the current one.
  • 429Rate limited. `X-RateLimit-Reset` says when to retry.
  • 500Something went wrong on our side. Retry; if it keeps happening, tell us.
  • 503Something this needs is not answering right now. Retry in a moment.
bash
curl https://pidgeon.ai/api/v1/export \
  -H "Authorization: Bearer $PIDGEON_API_KEY"

Generated · public/openapi.json