Distribution Lists

List the members of a distribution list

GET/distribution-lists/{id}/members
distribution-lists:readread_distribution_list_membersRead-only

Returns every live member of the list: users of your organisation and of its accepted client and provider organisations, not suspended or deleted. Each has id, first_name, last_name and email. It agrees with member_count. Changes nothing.

Path parameters

  • idintegerRequired#

    The distribution list's id. Distribution lists are keyed by integer ids, not UUIDs: a whole number from 1 to 2147483647.

Responses

200

Every member of the distribution list.

DistributionListMember[]
{
  "data": [
    {
      "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "first_name": "string",
      "last_name": "string",
      "email": "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
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

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