Export

Get export status

Returns the status and progress of an export job.

get/v1/account/{account}/export/{exportId}

Request

Base URL: https://your-emailengine-host
URL: https://your-emailengine-host/v1/account/{account}/export/{exportId}
Auth: HTTP bearer

Path parameters

accountstring required

Unique identifier for the email account

Example:user123

exportIdstring required

Export job identifier

Example:exp_abc123def456abc123def456

Headers

x-ee-timeoutinteger

Request timeout in milliseconds. Raises the command timeout above the EENGINE_TIMEOUT default for a long-running request; a value below the default has no effect

Example:30000

Response

Returns the export progress, and the download size once it has completed.

exportIdstring

Export job identifier

status'queued' | 'processing' | 'completed' | 'failed' | 'cancelled'

Export status

phase'indexing' | 'exporting' | 'complete'

Current export phase

foldersstring[]

Folders being exported

startDatestring date-time

Export start date filter

endDatestring date-time

Export end date filter

isEncryptedboolean

Whether the export file is encrypted

createdstring date-time

When export was created

expiresAtstring date-time

When export file expires

truncatedboolean

Whether the export was truncated due to message count or size limits. Only present (as true) for truncated exports

errorstring nullable

Error message if export failed

Example response

{
  "exportId": "exp_abc123def456abc123def456",
  "status": "processing",
  "phase": "indexing",
  "folders": [
    "INBOX"
  ],
  "startDate": "2024-01-01T00:00:00Z",
  "endDate": "2024-12-31T23:59:59Z",
  "progress": {
    "foldersScanned": 1,
    "foldersTotal": 2,
    "messagesQueued": 1500,
    "messagesExported": 500,
    "messagesSkipped": 5,
    "bytesWritten": 52428800
  },
  "created": "2024-01-15T10:30:00Z",
  "expiresAt": "2024-01-16T10:30:00Z",
  "truncated": true,
  "error": "Mailbox listing failed"
}

Changes

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