Groups

Get a group

GET/groups/{id}
groups:readget_groupRead-only

Returns one group. An unknown id, or a group your organisations cannot see, returns 404. Members are not embedded: use GET /groups/{group_id}/members.

Path parameters

  • idstring (uuid)Required#

    The group's id, a uuid. An unknown group, or one your organisations cannot see, returns 404.

Query parameters

  • fieldsstring#

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

Responses

200

The group.

Group
{
  "data": {
    "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "name": "string",
    "description": "string",
    "lead_user_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "parent_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "member_count": 1,
    "features": {
      "users_can_create_new_sub_groups": true,
      "can_be_invited_directly_to_group": true,
      "can_be_shown_in_sidebar": true,
      "user_auto_assign_to_classification": true,
      "can_invite_direct_investors": true
    },
    "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/groups/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"