Sign in

v1

latestOpenAPI 3.0.0http://www.apache.org/licenses/LICENSE-2.0.html2026-07-14543167.2 KB
groups

Returns an array of all Groups within a Heartbeat community

get/groups

Response

Successful response

idstring uuid
namestring
descriptionstring
colorstring The hex code color of the group
parentGroupIDstring uuid nullable

The id of the group's parent. Returns null if the group has no parent

archivedboolean

Whether the group has been archived or not

Example response

[
  {
    "name": "Party Planning Committee",
    "description": "Designated committee to plan holiday, birthday, & retirement parties",
    "color": "#FF6347",
    "users": [
      {
        "name": "Angela Martin",
        "email": "angela.martin@dundermifflin.com"
      }
    ]
  }
]