---
title: "List all groups"
method: GET
path: "/groups"
tags: ["Groups"]
---

# List all groups

`GET /groups`

Returns a list of your `groups`. The `groups` are returned sorted by creation date, with the most recent `groups` appearing first.

## Query parameters

- `employer_id` string
- `status` string
- `page` integer — The page of results to return. Defaults to 1 if not provided.
- `page_size` integer — The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.

## Headers

- `X-Platform-Id` string

## Response `200`

OK

- GroupResponsePagedList
  - `items` GroupResponse[], required — A paginated array containing the response elements
    - `id` string, required — Unique identifier for the `group`. Prefixed with `gr_`.
    - `name` string, required — Human-readable name of the `group`.
    - `description` string, nullable — Short description of the purpose or scope of the `group`.
    - `status` 'pending' | 'ready' | 'archived', required
    - `group_type` 'undefined' | 'single' | 'bundled', required
    - `enrolment_type` 'manual' | 'automatic', required
    - `employer_id` string, required — Identifier for the `employer` that owns this `group`. Prefixed with `er_`.
    - `object` string — The object type
    - `group_policy_ids` string[], required — Group policy unique identifiers associated with this group.
    - `group_quote_intent_ids` string[], required — Group quote intent unique identifiers associated with this group.
    - `group_policy_intent_ids` string[], required — Group policy intent unique identifiers associated with this group.
  - `page` integer, required — The current page of the results
  - `page_size` integer, required — The number of results on this page. This can be different from the requested page size if the total number of results is less than the requested page size
  - `total_count` integer, required — The total number of elements available in the response. This is the total number of elements available across all pages, not just the current page.
  - `has_next_page` boolean — Whether there are more pages available after this page
  - `has_previous_page` boolean — Whether there are more pages available before this page

---

[API](https://skmtc.net/kota/apis/kota-api.md) · [All operations](https://skmtc.net/kota/apis/kota-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kota/kota-api/revisions/7b8b3ed87c96/schema)