List roles

GET/roles

Lists the roles your organisation can see, one page at a time, by id: your own roles and the platform's global roles, never another organisation's and never a service role of an API token. Each role carries its permission ids. Search the name and label with filter[q], and narrow to global or own roles with filter[global]. Use GET /roles/{id}/permissions for the permissions with their keys and labels.

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: id, name, label or created_at. Prefix a field with - for descending. Defaults to id.
filter[q]string#
Roles whose name or label contains this text, ignoring case.
filter[global]boolean#
true for the platform's global roles, false for your organisation's own.

Responses

200

The roles.

Role[]

{
  "data": [
    {
      "id": 1,
      "name": "string",
      "label": "string",
      "description": "string",
      "global": true,
      "permission_ids": [
        1
      ],
      "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

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