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

# GET /invitations

`GET /invitations`

Return an array of all the invitations within a Heartbeat community

## Response `200`

Successful response

- Invitation[]
  - `id` string, uuid — The invitation id
  - `code` string — A 6 digit alphanumeric code included within the invitation link. Invitation links use the following format: https://app.heartbeat.chat/example/invitation?code=<CODE> OR https://example.customdomain.com/invitation?code=<CODE>
  - `role` object
    - `id` string, uuid — The id of the role
    - `name` string — The name of the role
  - `groups` object[]
    - `id` string, uuid — The id of the group
    - `name` string — The name of the group

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