Your AWS SES. Your dedicated Mailat. See how it works
Documentation

Export

Request, response and authentication details for your Mailat instance.

← All API operations
POST/api/v1/contacts/export

ExportContacts exports contacts as JSON POST /api/v1/contacts/export

Authentication & compatibility

Use a scoped bearer API key with contacts:manage. The key is bound to its user and organization.

Mailat application, account or shared resource API. Individual operations can require configured external services; this label is not a runtime-readiness guarantee.

Contract 2026-10-04. Your running instance's /api/v1/openapi.json is authoritative for its deployed release.

Request

Set MAILAT_BASE_URL to your instance origin (without /api/v1) and MAILAT_TOKEN to an appropriate credential. Replace path placeholders and example data before running. These examples do not execute in this page.

cURL request
curl --request POST "$MAILAT_BASE_URL/api/v1/contacts/export" \
  --header "Authorization: Bearer $MAILAT_TOKEN" \
  --header 'Content-Type: application/json' \
  --data @request.json

Build the request from the schema below; request.json and upload paths are local placeholders.

Request body (required)

application/json

bodyobjectrequired
Fields · model.ExportContactsRequest
formatstring

csv, json

listIdsarray
Each iteminteger (int64)
statusarray

active, unsubscribed, etc.

Each itemstring

Responses

HTTP statuses and body shapes below come from the pinned contract. Not every shared error applies to every request. Retain the original idempotency key when retrying a send.

200 · Success
Header: X-RateLimit-Remaininginteger

Remaining requests in this API key's current minute window (present for API-key authentication).

minimum: 0

application/json

responseobject
Fields
codeintegerrequired
dataarray
Each itemobject
Fields · model.Contact
attributesobject
Additional valuesany value
consentIpstring
consentSourcestring
consentTimestampall of · nullable
Variant 1string (date-time)
createdAtstring (date-time)
emailstring
engagementScorenumber
firstNamestring
idinteger (int64)
lastEngagedAtall of · nullable
Variant 1string (date-time)
lastNamestring
listsarray
Each itemobject
Fields · model.ListMembership
joinedAtstring (date-time)
listIdinteger (int64)
listNamestring
orgIdinteger (int64)
statusstring

active, unsubscribed, bounced, complained

updatedAtstring (date-time)
uuidstring
messagestringrequired
400 · Invalid input

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
401 · Missing, expired or revoked authentication

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
403 · Insufficient permission

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
404 · Resource not found

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
409 · Conflict or changed idempotency payload

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
410 · Recovery cursor expired; resynchronize

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
429 · Rate limit exceeded; respect Retry-After
Header: Retry-Afterinteger

Seconds until the next fixed-minute request window.

minimum: 1

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
500 · Internal failure; retain the idempotency key

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
Download the full OpenAPI contract