The response envelope

Responses are wrapped in a consistent envelope. data holds the payload; pagination appears only on paged lists; on failures errors is populated and meta.status becomes FAILURE.

{
  "data": /* payload: object or array */,
  "pagination": { "pageNumber": 1, "pageSize": 20, "totalElements": 151, "totalPages": 8 },
  "errors": [ { "errorCode": "...", "message": "...", "detail": "..." } ],
  "meta": { "status": "SUCCESS", "timestamp": "..." }
}

Gateway-level auth errors (401 / 403) are the exception: they have no body at all. Only errors from the services carry the errors envelope.

Authentication Asynchronous writes

Getting Started

Core Concepts

Contacts

Contact Activity

Lists and Members

Emails

Email Versions