Exports
Create
Queues a background dump of every ticket in the workspace, with each ticket and its messages written as EML files inside one or more ZIP archives; the only supported type is EML, and the record comes back immediately with no status on it, so a successful call says nothing about whether the export will finish. One export per workspace per 7 days is allowed, there is no endpoint to poll progress, and the person who started it is emailed download links when the dump is done (the archives are removed from storage about two weeks later).
POST
/api/{tenant:minlength(2)}/v{version:apiVersion}/exports
Request arguments
| Name | Type | Source |
|---|---|---|
| input | DTO_export | Body |
Request body example
Response
Response body example
DTO_export
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| created_by | DTO_reference_user | ReadOnly | Created by |
| last_updated_by | DTO_reference_user | ReadOnly | Last updated by |
| id | Int32 | ReadOnly | Leave empty on input |
| created | DateTime | ReadOnly | Created |
| last_updated | DateTime | ReadOnly | Last updated |
| type | ENUM export_type | Type |
DTO_reference_user
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| profile_pic | String | ReadOnly | Profile pic |
| String | ReadOnly | ||
| id | Int32 | Id | |
| label | Object | ReadOnly | Label |
ENUM export_type
| Value | Name | Description |
|---|---|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | EML | EML |
Generated Aug 4, 2026 18:37