Distribution Lists

List the sends made to a distribution list

GET/distribution-lists/{distribution_list_id}/sends
distribution-lists:readlist_distribution_list_sendsRead-only

Lists the emails sent to one distribution list, newest first, each with its delivery status and its recipient, email and failure counts. filter[status] keeps sends in one state. An unknown list, one in another organisation or a deleted one returns 404. Changes nothing.

Path parameters

  • distribution_list_idintegerRequired#

    The distribution list's id. Distribution lists are keyed by integer ids, not UUIDs. An unknown list, one in another organisation or a deleted one 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. Prefix a field with - for descending. Defaults to -created_at. The send id is always the final tiebreak.

  • filter[status]string#

    Only sends in this state: queued, sending, sent or failed. Takes [in] and [not_in] with a comma-separated list.

    One of: queued, sending, sent, failed

Responses

200

One page of the list's sends.

DistributionListSend[]
{
  "data": [
    {
      "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "status": "queued",
      "recipient_count": 1,
      "email_count": 1,
      "failed_count": 1,
      "error": "string",
      "deal_ids": [
        "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a"
      ],
      "created_by": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "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/distribution-lists/{distribution_list_id}/sends\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"