---
title: "Returns a list of usergroups"
method: GET
path: "/user-groups"
tags: ["Usergroups"]
---

# Returns a list of usergroups

`GET /user-groups`

## Request

- Base URL: `https://api.kontainer.com/jsonapi/v2`
- URL: `https://api.kontainer.com/jsonapi/v2/user-groups`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/kontainer/apis/kontainer-api-documentation/docs/user-groups/get.ts> (a function with typed inputs; its response is checked against the schema)

## Retrieve Usergroups
    Endpoint for retrieving a collection of Usergroups.

## Query parameters

- `page[size]` integer
- `page[number]` integer

## Response `200`

success

- UsergroupCollectionResponse
  - `data` Usergroup[]
    - `type` 'user_group', required
    - `id` string, required
    - `attributes` object, required
      - `name` string, required
      - `note` string, required
      - `active` boolean, required
      - `show_brand_section` 0 | 1, required: Stored flag returned uncast: `0` or `1` when the group is read back. Create and update responses echo the value that was submitted (a JSON boolean, `0`/`1` or `"0"`/`"1"`).
      - `hide_menu_by_default` boolean, required
      - `can_folder_share` boolean, required: Whether members may share folders externally. Written via `allow_folder_share`; always `false` while the client has external sharing disabled.
      - `can_internal_folder_share` boolean, required: Whether members may share folders internally. Written via `allow_internal_folder_share`.
      - `allow_cdn_activation_with_download_access` boolean, required
      - `is_sso_group` boolean, required: Whether the group is mapped to an SSO group name.
  - `links` UsergroupPaginationLinks
    - `first` string
    - `last` string
    - `prev` string, nullable
    - `next` string, nullable
  - `meta` UsergroupPaginationMeta
    - `current_page` integer
    - `from` integer
    - `last_page` integer
    - `links` object[]
      - `url` string, nullable
      - `label` string
      - `active` boolean
    - `path` string
    - `per_page` integer
    - `to` integer
    - `total` integer
    - `filter` union: The `filter` query parameter echoed back as sent; an empty array when none was sent
      - object
      - unknown[]
        - unknown
    - `sort` string, nullable

## Other responses

- `401`: Unauthorized

---

[API](https://skmtc.dev/kontainer/apis/kontainer-api-documentation.md) - [All operations](https://skmtc.dev/kontainer/apis/kontainer-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/kontainer/apis/kontainer-api-documentation/revisions/b80a5167e09a?raw)