Export sent emails
/communications/emails/exportsStarts an export of the token organisation's emails a list would return, as a CSV file, and returns 202 with a job and its Location. The body takes the same filter and sort as GET /communications/emails. Poll GET /jobs/{id}; when it succeeds, its result.download_url gives the file for 7 days. It queues one job and sends nothing; the job can be cancelled with POST /jobs/{id}/actions/cancel. The export has no body columns.
Headers
Makes a retry safe. Send a new UUID for each new request and reuse it only to retry that request; the first response is replayed for 24 hours.
Request body
application/json, optional
The filters of the list, written as in
GET /communications/emails, such as { "status": "sent" }. Operators nest the same way, such as { "sent_at": { "gte": "2026-10-01" } }.Comma-separated fields to sort by, as on the list. Prefix a field with
-for descending.- One of:
The file format. Only csv is offered, and it is the default.
csv
{
"filter": {
"status": "sent"
}
}Responses
{
"data": {
"id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
"type": "string",
"status": "queued",
"progress": {
"done": 1,
"total": 1
},
"result": {},
"error": {},
"created_at": "2026-06-12T10:00:00+00:00",
"updated_at": "2026-06-12T10:00:00+00:00",
"completed_at": "2026-06-12T10:00:00+00:00"
}
}Authorization failed. error.code is one of org_disabled,
ip_blocked, missing_scope, scope_disabled, user_disabled.
The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per
problem, or a code documented on the operation.
Examples
curl -X POST https://your-org-domain/kong/core/api/v2/communications/emails/exports\
-H "Authorization: Bearer $HELM_API_KEY"\
-H "Content-Type: application/json"\
-d '{
"filter": {
"status": "sent"
}
}'