CC Lists

Get a CC list

GET/cc-lists/{id}
cc-lists:readget_cc_listRead-only

Returns one CC list with its recipient and assignment counts. An unknown id, a deleted list or another organisation's list returns 404. Use GET /cc-lists to list them. Changes nothing.

Path parameters

  • idintegerRequired#

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

Query parameters

  • fieldsstring#

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

Responses

200

The CC list.

CcList
{
  "data": {
    "id": 1,
    "name": "string",
    "recipient_count": 1,
    "assigned_count": 1,
    "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/cc-lists/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"