Get a group

GET 
/groups/:id.json

Get a group

Request

Path Parameters

id stringrequired
Use group name instead of id
Example: name

Responses

200

success response

application/json

Schema

Schema

group objectrequired
id integerrequired
automatic booleanrequired
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
members_visibility_level integerrequired
can_see_members booleanrequired
can_admin_group booleanrequired
can_edit_group booleanrequired
publish_read_state booleanrequired
is_group_owner_display booleanrequired
mentionable booleanrequired
messageable booleanrequired
automatic_membership_email_domains stringnullrequired
smtp_updated_at stringnullrequired
smtp_updated_by objectnullrequired
smtp_enabled booleanrequired
smtp_server stringnullrequired
smtp_port stringnullrequired
smtp_ssl stringnullrequired
imap_enabled booleanrequired
imap_updated_at stringnullrequired
imap_updated_by objectnullrequired
imap_server stringnullrequired
imap_port stringnullrequired
imap_ssl stringnullrequired
imap_mailbox_name stringrequired
imap_mailboxes undefined[]required
email_username stringnullrequired
email_from_alias stringnullrequired
email_password stringnullrequired
imap_last_error stringnullrequired
imap_old_emails stringnullrequired
imap_new_emails stringnullrequired
message_count integerrequired
allow_unknown_sender_topic_replies booleanrequired
associated_group_ids undefined[]required
watching_category_ids undefined[]required
tracking_category_ids undefined[]required
watching_first_post_category_ids undefined[]required
regular_category_ids undefined[]required
muted_category_ids undefined[]required
watching_tags undefined[]required
watching_first_post_tags undefined[]required
tracking_tags undefined[]required
regular_tags undefined[]required
muted_tags undefined[]required
extras objectrequired
visible_group_names undefined[]required

Example (from schema)

{
  "group": {
    "id": 0,
    "automatic": true,
    "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,
    "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,
    "smtp_enabled": true,
    "imap_enabled": true,
    "imap_mailbox_name": "string",
    "imap_mailboxes": [
      null
    ],
    "message_count": 0,
    "allow_unknown_sender_topic_replies": true,
    "associated_group_ids": [
      null
    ],
    "watching_category_ids": [
      null
    ],
    "tracking_category_ids": [
      null
    ],
    "watching_first_post_category_ids": [
      null
    ],
    "regular_category_ids": [
      null
    ],
    "muted_category_ids": [
      null
    ],
    "watching_tags": [
      null
    ],
    "watching_first_post_tags": [
      null
    ],
    "tracking_tags": [
      null
    ],
    "regular_tags": [
      null
    ],
    "muted_tags": [
      null
    ]
  },
  "extras": {
    "visible_group_names": [
      null
    ]
  }
}

Loading...