Groups

List groups

GET

https://discourse.example.com/groups.json

List groups

curl -X GET 'https://discourse.example.com/groups.json'

const response = await fetch('https://discourse.example.com/groups.json', {
  method: 'GET',
});

const data = await response.text();

import requests

response = requests.get('https://discourse.example.com/groups.json')
print(response.text)

200

{
  "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,
      "title": "string",
      "grant_trust_level": "string",
      "incoming_email": "string",
      "has_messages": true,
      "flair_url": "string",
      "flair_bg_color": "string",
      "flair_color": "string",
      "bio_raw": "string",
      "bio_cooked": "string",
      "bio_excerpt": "string",
      "public_admission": true,
      "public_exit": true,
      "allow_membership_requests": true,
      "full_name": "string",
      "default_notification_level": 0,
      "membership_request_template": "string",
      "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": []
  },
  "total_rows_groups": 0,
  "load_more_groups": "string"
}

Response

200OKany

response

Response fields application/json

groupsArray<object>required

Show child attributes

idintegerrequired

automaticbooleanrequired

namestringrequired

display_namestringrequired

user_countinteger

mentionable_levelintegerrequired

messageable_levelintegerrequired

visibility_levelintegerrequired

primary_groupbooleanrequired

titlestring | nullrequired

grant_trust_levelstring | nullrequired

incoming_emailstring | nullrequired

has_messagesbooleanrequired

flair_urlstring | nullrequired

flair_bg_colorstring | nullrequired

flair_colorstring | nullrequired

bio_rawstring | nullrequired

bio_cookedstring | nullrequired

bio_excerptstring | nullrequired

public_admissionbooleanrequired

public_exitbooleanrequired

allow_membership_requestsbooleanrequired

full_namestring | nullrequired

default_notification_levelintegerrequired

membership_request_templatestring | nullrequired

is_group_userboolean

is_group_ownerboolean

members_visibility_levelintegerrequired

can_see_membersbooleanrequired

can_admin_groupbooleanrequired

can_edit_groupboolean

publish_read_statebooleanrequired

extrasobjectrequired

Show child attributes

type_filtersArray<any>required

total_rows_groupsintegerrequired

load_more_groupsstringrequired

Docs by Sourcey