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

# GET /groups

`GET /groups`

Returns an array of all Groups within a Heartbeat community

## Response `200`

Successful response

- Group[]
  - `id` string, uuid
  - `name` string
  - `description` string
  - `color` string, The hex code color of the group
  - `parentGroupID` string, uuid, nullable — The id of the group's parent. Returns null if the group has no parent
  - `users` object[]
    - `id` string, uuid — The heartbeat user id
    - `name` string
    - `email` string, email — the email of the user
  - `archived` boolean — Whether the group has been archived or not

## Other responses

- `401` — API Key is missing or invalid

---

[API](https://skmtc.dev/heartbeat/apis/heartbeat-api.md) · [All operations](https://skmtc.dev/heartbeat/apis/heartbeat-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/heartbeat/heartbeat-api/revisions/6c3cf537d508/schema)