Search users for classification assignment

GET/classifications/user-search

classifications:read search_classification_usersRead-onlyDeprecatedSunset 2027-06-30

Cursor-paginated search of the organisation directory for users to add to classifications. Filter by free-text q. Deprecated: withdrawn on 2027-06-30. GET /investors?filter[q]= replaces it, for investors only; this route spans every user type.

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 on username, name and contact email.

Responses

200

{
  "data": [
    {
      "id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
      "first_name": "Ada",
      "last_name": "Lovelace",
      "email": "ada@example.test",
      "status": "Active",
      "automatic": null
    }
  ],
  "links": {
    "first": null,
    "last": null,
    "prev": null,
    "next": "https://your-org-domain/kong/core/api/v2/classifications/user-search?cursor=eyJpZCI6MjUsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0"
  },
  "meta": {
    "path": "https://your-org-domain/kong/core/api/v2/classifications/user-search",
    "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

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