Export

List exports

Lists all exports for an account with pagination.

get/v1/account/{account}/exports

Request

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

Path parameters

accountstring required

Unique identifier for the email account

Example:user123

Query parameters

pageinteger

Page number (zero indexed)

pageSizeinteger

How many entries per page

Example:20

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 exports for the account with their progress.

totalinteger

Total number of exports

pageinteger

Current page number

pagesinteger

Total number of pages

Example response

{
  "total": 5,
  "pages": 1,
  "exports": [
    {
      "exportId": "exp_abc123def456abc123def456",
      "status": "completed",
      "created": "2024-01-15T10:30:00Z",
      "expiresAt": "2024-01-16T10:30:00Z"
    }
  ]
}

Changes

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