---
title: "List groups and the membership of the groups"
method: GET
path: "/groups-report"
tags: ["Groups"]
---

# List groups and the membership of the groups

`GET /groups-report`

## Request

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

The list of group memebership with the following fields:
  * group description
  * group member user email
Format is JSON by default or csv format if Request Header Accept 'text/csv' is specified.

Included on report: groups acting as a role (i.e. publishers, admin)
Excluded from Report: groups that are empty of users

## Headers

- `Accept` 'application/json' | 'text/csv'

## Response `200`

The list of groups and members

- GroupUser[]: A list of group descriptions and members emails
  - `group` string: The group description
  - `user` string: The user email

## Other responses

- `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)