List groups

GET 
/groups.json

List groups

Responses

200

response

application/json

Schema

Schema

groups object[]required
Array [
id integerrequired
automatic booleanrequired
name stringrequired
display_name stringrequired
user_count integerrequired
mentionable_level integerrequired
messageable_level integerrequired
visibility_level integerrequired
primary_group booleanrequired
title stringnullrequired
grant_trust_level stringnullrequired
incoming_email stringnullrequired
has_messages booleanrequired
flair_url stringnullrequired
flair_bg_color stringnullrequired
flair_color stringnullrequired
bio_raw stringnullrequired
bio_cooked stringnullrequired
bio_excerpt stringnullrequired
public_admission booleanrequired
public_exit booleanrequired
allow_membership_requests booleanrequired
full_name stringnullrequired
default_notification_level integerrequired
membership_request_template stringnullrequired
is_group_user booleanrequired
is_group_owner booleanrequired
members_visibility_level integerrequired
can_see_members booleanrequired
can_admin_group booleanrequired
can_edit_group booleanrequired
publish_read_state booleanrequired
]
extras objectrequired
type_filters undefined[]required
total_rows_groups integerrequired
load_more_groups stringrequired

Example (from schema)

{
  "groups": [
    {
      "id": 0,
      "automatic": true,
      "name": "string",
      "display_name": "string",
      "user_count": 0,
      "mentionable_level": 0,
      "messageable_level": 0,
      "visibility_level": 0,
      "primary_group": true,
      "has_messages": true,
      "public_admission": true,
      "public_exit": true,
      "allow_membership_requests": true,
      "default_notification_level": 0,
      "is_group_user": true,
      "is_group_owner": true,
      "members_visibility_level": 0,
      "can_see_members": true,
      "can_admin_group": true,
      "can_edit_group": true,
      "publish_read_state": true
    }
  ],
  "extras": {
    "type_filters": [
      null
    ]
  },
  "total_rows_groups": 0,
  "load_more_groups": "string"
}

Loading...