---
title: "GET /core/groups/"
method: GET
path: "/core/groups/"
tags: ["core"]
---

# GET /core/groups/

`GET /core/groups/`

Group Viewset

## Query parameters

- `attributes` string
- `include_children` boolean
- `include_inherited_roles` boolean
- `include_parents` boolean
- `include_users` boolean
- `is_superuser` boolean
- `members_by_pk` integer[]
- `members_by_username` string[]
- `name` string
- `ordering` string
- `page` integer
- `page_size` integer
- `search` string

## Response `200`

- PaginatedGroupList
  - `pagination` Pagination, required
    - `next` number, required
    - `previous` number, required
    - `count` number, required
    - `current` number, required
    - `total_pages` number, required
    - `start_index` number, required
    - `end_index` number, required
  - `results` Group[], required
    - `pk` string, uuid, required
    - `num_pk` integer, required
    - `name` string, required
    - `is_superuser` boolean — Users added to this group will be superusers.
    - `parents` string[]
    - `parents_obj` RelatedGroup[], nullable, required
      - `pk` string, uuid, required
      - `name` string, required
      - `is_superuser` boolean — Users added to this group will be superusers.
      - `attributes` object
      - `group_uuid` string, uuid, required
    - `users` integer[]
    - `users_obj` PartialUser[], nullable, required
      - `pk` integer, required
      - `username` string, required — Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
      - `name` string, required — User's display name.
      - `is_active` boolean — Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
      - `last_login` string, date-time, nullable
      - `email` string, email
      - `attributes` object
      - `uid` string, required
    - `attributes` object
    - `roles` string[]
    - `roles_obj` Role[], required
      - `pk` string, uuid, required
      - `name` string, required
    - `inherited_roles_obj` Role[], nullable, required
      - `pk` string, uuid, required
      - `name` string, required
    - `children` string[], required
    - `children_obj` RelatedGroup[], nullable, required
      - `pk` string, uuid, required
      - `name` string, required
      - `is_superuser` boolean — Users added to this group will be superusers.
      - `attributes` object
      - `group_uuid` string, uuid, required
  - `autocomplete` Autocomplete, required

## Other responses

- `400`
- `403`

---

[API](https://skmtc.dev/goauthentik/apis/authentik.md) · [All operations](https://skmtc.dev/goauthentik/apis/authentik/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/goauthentik/authentik/revisions/4e42e86021d7/schema)