Groups

Get a group by id

GET

https://discourse.example.com/groups/by-id/{id}.json

Get a group by id

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

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

const data = await response.text();

import requests

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

200

{
  "group": {
    "id": 0,
    "automatic": true,
    "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,
    "members_visibility_level": 0,
    "can_see_members": true,
    "can_admin_group": true,
    "can_edit_group": true,
    "publish_read_state": true,
    "is_group_owner_display": true,
    "mentionable": true,
    "messageable": true,
    "automatic_membership_email_domains": "string",
    "smtp_updated_at": "string",
    "smtp_updated_by": {},
    "smtp_enabled": true,
    "smtp_server": "string",
    "smtp_port": "string",
    "smtp_ssl_mode": 0,
    "email_username": "string",
    "email_from_alias": "string",
    "email_password": "string",
    "message_count": 0,
    "allow_unknown_sender_topic_replies": true,
    "associated_group_ids": [],
    "watching_category_ids": [],
    "tracking_category_ids": [],
    "watching_first_post_category_ids": [],
    "regular_category_ids": [],
    "muted_category_ids": [],
    "watching_tags": [],
    "watching_first_post_tags": [],
    "tracking_tags": [],
    "regular_tags": [],
    "muted_tags": []
  },
  "extras": {
    "visible_group_names": []
  }
}

Parameters

idstringrequiredpath

Use group name instead of id

Response

200OKany

success response (by id)

Response fields application/json

groupobjectrequired

Show child attributes

idintegerrequired

automaticbooleanrequired

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_userbooleanrequired

members_visibility_levelintegerrequired

can_see_membersbooleanrequired

can_admin_groupbooleanrequired

can_edit_groupboolean

publish_read_statebooleanrequired

is_group_owner_displaybooleanrequired

mentionablebooleanrequired

messageablebooleanrequired

automatic_membership_email_domainsstring | nullrequired

smtp_updated_atstring | null

smtp_updated_byobject | null

smtp_enabledboolean

smtp_serverstring | nullrequired

smtp_portstring | nullrequired

smtp_ssl_modeinteger | nullrequired

email_usernamestring | nullrequired

email_from_aliasstring | null

email_passwordstring | nullrequired

message_countintegerrequired

allow_unknown_sender_topic_repliesbooleanrequired

associated_group_idsArray<any>

watching_category_idsArray<any>required

tracking_category_idsArray<any>required

watching_first_post_category_idsArray<any>required

regular_category_idsArray<any>required

muted_category_idsArray<any>required

watching_tagsArray<any>

watching_first_post_tagsArray<any>

tracking_tagsArray<any>

regular_tagsArray<any>

muted_tagsArray<any>

extrasobjectrequired

Show child attributes

visible_group_namesArray<any>required

Docs by Sourcey