Distribution Lists

Get a send to a distribution list

GET/distribution-lists/{distribution_list_id}/sends/{id}
distribution-lists:readget_distribution_list_sendRead-only

Returns one send of the list with its current status, counts and any error, so you can follow delivery after creating it. An unknown list, or a send of another list or organisation, returns 404. Use GET /distribution-lists/{distribution_list_id}/sends to list them. 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.

  • idstring (uuid)Required#

    The send's id.

Query parameters

  • fieldsstring#

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

Responses

200

The send.

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"
  }
}
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
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/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"