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

# List groups

`GET /groups`

## Request

- Base URL: `/v1` (relative, and the document’s source URL is not known)
- URL: `/v1/groups`
- Auth: API key in header `Authorization`

List all the groups in the user pool

## Query parameters

- `sort` 'created' | 'name' | 'name:asc' | 'name:desc'

## Response `200`

The list of groups

- GroupList: A list of groups
  - `groups` Group[]
    - `id` string: The group ID
    - `name` string: The group name
    - `precedence` integer: The priority of the group
    - `created` string, date-time: The date the group was created
    - `last_modified_date` string, date-time
    - `role_arn` string
    - `user_pool_id` string
  - `count` integer

## Other responses

- `400`: Request rejected due to invalid parameters supplied
- `401`: Authentication information is missing or invalid
- `500`: Failed to process the request due to an internal error

---

[API](https://skmtc.dev/office-of-national-statistics/apis/identity-api.md) - [All operations](https://skmtc.dev/office-of-national-statistics/apis/identity-api/llms.txt) - [OpenAPI document](https://skmtc.dev/office-of-national-statistics/apis/identity-api/revisions/6472459b6b03?raw)