Skip to main content
POST
Bulk entity export by email

Overview

Exports entities using the same filters as GET /entities, builds a file (csv, xlsx, or json), and delivers it by email. Returns 202 with jobId; poll status via GET /entities/export/jobs/{jobId}.

Endpoint

Auth, permissions, marketplace

Same as Email entity PDF report: Authorization, X-Organization-ID, entities:export, global_sender_email enabled, billing per recipient in recipientEmails.

Domain and sender

Same rules as the PDF email export:
  • fromEmail: verified org domain; no sender row required.
  • fromSenderId: UUID in organization_email_senders.
  • Do not send both.

Request Body

string[]
required
Email recipients (max 26 after deduplication). Only these addresses; the API user’s email is not auto-added.
string
required
csv, xlsx, or json.
object
Same shape as GET /entities query filters. Default {}.
string
en, es, or pt for the completion email.
string[]
Optional snake_case export column keys; omit or [] for all allowed columns.
string (uuid)
Sender UUID. Mutually exclusive with fromEmail.
string
From address on a verified domain. Mutually exclusive with fromSenderId.

Example

202 response

Job follow-up

  • GET /entities/export/jobs/{jobId} β€” status (queued, running, completed, failed).
  • GET /entities/export/jobs/{jobId}/download β€” download metadata when available.
  • Completion email may include a signed link (depends on server S3 settings).

400 errors

Same pre-flight codes as report-export-email.