Communications

Get a sent email

GET/communications/emails/{id}
communications:readget_sent_emailRead-only

Returns one of the token organisation's emails, with its recipient counts, opens and clicks. sent_at is when it first went to a recipient. The body is left out unless you send include=body, which adds body_html and body_text. An unknown id, or one belonging to another organisation, returns 404. Use GET /communications/emails to find emails.

Path parameters

  • idstring (uuid)Required#

    The record's id.

Query parameters

  • fieldsstring#

    Comma-separated top-level fields to return. id is always returned.

  • includestring#

    Comma-separated related records to embed, from the operation's allowed list.

Responses

200

The sent email.

SentEmail
{
  "data": {
    "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "subject": "string",
    "status": "queued",
    "template": "string",
    "sender_email": "string",
    "sender_name": "string",
    "source_type": "distribution",
    "source_label": "string",
    "deal_ids": [
      "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a"
    ],
    "recipient_count": 1,
    "opens": 1,
    "clicks": 1,
    "sent_at": "2026-06-12T10:00:00+00:00",
    "body_html": "string",
    "body_text": "string",
    "created_at": "2026-06-12T10:00:00+00:00",
    "updated_at": "2026-06-12T10:00:00+00:00"
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/communications/emails/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"