Internal Users

List an internal user's emails

GET/internal-users/{internal_user_id}/emails
internal-users:readlist_internal_user_emailsRead-only

Lists the emails the platform queued for one internal user, newest first, with subject, template, status, source and sender but never the body. filter[source_type] keeps one source. An unknown internal user returns 404. Use GET /internal-users/{internal_user_id}/emails/{id} for one. Sends nothing.

Path parameters

  • internal_user_idstring (uuid)Required#

    The internal user's id, a uuid. An unknown internal user, or one outside the token's organisation, returns 404.

Query parameters

  • limitinteger#

    Page size (1–100). Defaults to 25; values are clamped to the range.

    Default: 25
  • cursorstring#

    Opaque pagination cursor taken from a prior response's meta.next_cursor.

  • fieldsstring#

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

  • sortstring#

    Comma-separated fields to sort by: created_at or updated_at. Prefix a field with - for descending. Defaults to -created_at.

  • filter[source_type]string#

    Only emails from this source: distribution, invite, notification, deal_promotion, workflow, account or custom. Takes [in] and [not_in] with a comma-separated list.

    One of: distribution, invite, notification, deal_promotion, workflow, account, custom

Responses

200

One page of the internal user's emails.

InternalUserEmail[]
{
  "data": [
    {
      "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "subject": "string",
      "template": "string",
      "status": "queued",
      "source_type": "distribution",
      "source_label": "string",
      "sender_email": "string",
      "created_at": "2026-06-12T10:00:00+00:00",
      "updated_at": "2026-06-12T10:00:00+00:00"
    }
  ],
  "meta": {
    "limit": 1,
    "next_cursor": "string",
    "prev_cursor": "string"
  }
}
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/internal-users/{internal_user_id}/emails\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"