---
title: "List the authenticated user's guest groups"
method: GET
path: "/v1/guests/groups/"
tags: ["Guests"]
---

# List the authenticated user's guest groups

`GET /v1/guests/groups/`

## Request

- Base URL: `https://api.educaplay.com`
- URL: `https://api.educaplay.com/v1/guests/groups/`
- Auth: HTTP bearer

Groups work as tags: a guest may belong to several groups or to none. Each group comes with the number of guests tagged with it.

## Response `200`

Groups of the authenticated user.

- GuestGroupListResponse
  - `_embedded` object, required
    - `groups` GuestGroup[], required
      - `id` integer, required
      - `name` string, required
      - `count` integer: Number of guests tagged with this group. Only present when listing groups.
  - `_links` HalLink[], required
    - `rel` string, required
    - `href` string, uri, required

## Other responses

- `401`: Authentication is missing or the Bearer token is invalid.
- `429`: The request rate limit for the account has been exceeded. Limits depend on the subscription plan (Basic 120, Advanced 300, Academic 600 and Commercial 1200 requests per minute) and are measured over a fixed 60 second window. Wait the number of seconds given in the `Retry-After` header before retrying.

---

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