Classifications

List users in a classification

GET/classifications/{classificationId}/users
classifications:readlist_classification_usersRead-onlyDeprecatedSunset 2027-06-30

Cursor-paginated list of the users in one classification. Filter by free-text q. Deprecated: it will be withdrawn on 2027-06-30; use GET /classifications/{classification_id}/members instead.

Path parameters

  • classificationIdintegerRequired#

    The classification's integer id.

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.

  • qstring#

    Free-text search within the classification's users.

Responses

200

OK

{
  "data": [
    {
      "id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
      "first_name": "Ada",
      "last_name": "Lovelace",
      "email": "ada@example.test",
      "status": "Active",
      "automatic": false
    },
    {
      "id": "1c8a2f5e-4d6b-4a1c-9e3f-7b0a2c4d6e8f",
      "first_name": "Alan",
      "last_name": "Turing",
      "email": "alan@example.test",
      "status": "Active",
      "automatic": true
    }
  ],
  "links": {
    "first": null,
    "last": null,
    "prev": null,
    "next": "https://your-org-domain/kong/core/api/v2/classifications/42/users?cursor=eyJpZCI6MjUsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0"
  },
  "meta": {
    "path": "https://your-org-domain/kong/core/api/v2/classifications/42/users",
    "per_page": 25,
    "next_cursor": "eyJpZCI6MjUsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0",
    "prev_cursor": null
  }
}
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

Request validation failed (HTTP 422). The body is either the Laravel validation envelope (message + field-keyed errors) or the API error envelope for domain rejections (e.g. form_type_not_supported, folder_locked, parent_not_found, folder_not_empty).

429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/classifications/{classificationId}/users\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"