Skip to main content
GET
/
groups
List groups
curl --request GET \
  --url https://api.example.com/groups
{
  "data": [
    {
      "id": 1,
      "content_type": "group",
      "name": "Team Alpha",
      "description": "<string>",
      "type": "public",
      "mute_rule": 123,
      "has_unread_notifications": true,
      "only_admin_publish": 123,
      "post_comments_enabled_default": true,
      "member": "<string>",
      "image": {},
      "auto": {},
      "url": "api/groups/1",
      "permissions": {
        "member": "<string>",
        "edit": true,
        "delete": true
      },
      "publish": {
        "updated_at": 123
      },
      "membership": {
        "auto": true
      },
      "stats": {
        "active": 123
      }
    }
  ]
}

Query Parameters

​
mode
enum<string>

Filter groups by membership mode. member lists groups the user is a member of, available lists joinable public groups, and can_publish lists groups where the user is allowed to publish.

Available options:
member,
available,
can_publish
​
type
enum<string>

Filter by group visibility type.

Available options:
public,
private
​
sort
enum<string>

Sorting method for the group list. activity sorts by most recently updated, name sorts alphabetically.

Available options:
activity,
name
​
limit
integer

Maximum number of groups per page (1–100). Defaults to 50.

Required range: 1 <= x <= 100

Response

200 - application/json

Paginated list of groups.

​
data
object[]