SLslashy
Exports

Get an export and its download links

The export's status and, once it has succeeded, a fresh presigned link to each inbox's file (valid for up to an hour; GET again for new ones). Files are deleted 7 days after the export started (expires_at); after that url is null. Only inboxes the key can still read are listed, and an export with content columns needs mail.content.read (insufficient_scope otherwise).

Scope: mail.metadata.read. Rate limit class: read (600/minute per key).

get/v1/exports/{export_id}

Request

  • Base URL
    https://api.slashy.com
  • URL
    https://api.slashy.com/v1/exports/{export_id}
  • Auth
    HTTP bearer

Path parameters

export_idstring uuid required

id from POST /v1/exports.

Response

OK

idstring uuid required
status'queued' | 'running' | 'succeeded' | 'failed' required
created_atstring date-time required
started_atstring date-time nullable required
finished_atstring date-time nullable required
expires_atstring date-time nullable required

When the files are deleted (7 days after the export started); set once it succeeds.

inbox_idsstring[] required

The exported inboxes this key can read.

sincestring date-time nullable required
include_contentboolean required

Whether the files have the mail.content.read columns. Downloading them needs that scope.

row_countinteger nullable required

Messages across the files this key can read; set once it succeeds.

errorstring nullable required

Why the export failed.

Changes

No recorded changes to this operation across all 1 revision of this API.