Skip to content

POST /contacts/export​

POST
/contacts/export

Export everything held about one contact as a streamed JSON download: the
contact, its custom fields, tags, visitors, all events, its opt-outs
(unsubscribes, suppressions, confirmations) and delivery metadata. Rendered
message bodies are not included. Identify the contact by exactly one of
id or email.

Authorizations​

BearerAuth
Type
HTTP (Bearer)

Parameters​

Query Parameters

id

The contact's id

Type
string
Pattern
"^[0-9]+$"
email

The contact's email address

Type
string
Format
"email"

Responses​

Attachment download of everything held about one contact (subject access, GDPR Art. 15/20): the ContactExportDocument JSON, streamed

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI