API Reference version 2

View group

GET/v2/group/{group_id}

Get a group's details.

Authentication required, with scope view_group.
Accessible by group clients, users.

Path parameters

Type Parameter Description Required?
string id

The id of the group to view.

Required
200 application/json
Type Property Description Required?
string domain

The Google Apps domain, if applicable

May be null.

Required
object statistics

Statistics for this group.

Required
object links

URLs to retrieve more information

Required
string self

The URL to use to retrieve group statistics

Required
string name

Group name

Required
string created

The date in ISO-8601 when the group was created

Required
string avatar_url

URL to group's avatar. 125px on the longest side.

May be null.

Required
object plan

Presence information for the user

Required
string type

Plan type

Valid values: unknown, free, trial, plus, premium, non_profit.

Required
integer id

Plan ID

Required
object owner

The group owner.

string mention_name

User's @mention name

Required
string version

An etag-like random version string.

Required
integer id

The user ID

Required
object links

URLs to retrieve user information

Required
string self

The link to use to retrieve the user information

Required
string name

The display user name

Required
string subdomain

The name used as the prefix to the HipChat domain

Required
integer id

Group ID

Required