Skip to main content

Get All Groups

Authentication

Authentication is optional. If authenticated, the response includes membership status for each group.

Response

boolean
Indicates whether the request was successful
array
Array of community group objects

Code Example

Response Example


Create Group

Authentication

This endpoint requires user authentication.

Request Body

string
required
Name of the group (1-60 characters, will be trimmed)
string
Description of the group (max 200 characters, will be trimmed)
string
Emoji or icon for the group (default: 💬)

Response

boolean
Indicates whether the group was created successfully
object
The newly created group object (same structure as Get Groups response)
string
Error message if success is false

Code Example

Response Example

Success
Duplicate Name

Toggle Group Membership

Authentication

This endpoint requires user authentication.

Path Parameters

string
required
The unique identifier of the group

Response

boolean
Indicates whether the operation was successful
boolean
New membership status (true if joined, false if left)

Code Example

Response Example

Joined
Left

Notes

  • Groups are sorted by official status first, then by member count (descending)
  • The slug is automatically generated from the group name
  • Group creators are automatically made members of the group
  • Toggling membership is idempotent - calling it multiple times toggles between joined/left states
  • Official groups can only be created by platform administrators
  • Group names must be unique (case-insensitive)