API Reference version 2

Get room

GET/v2/room/{room_id_or_name}

Get room details.

Path parameters

Type Parameter Description Required?
string room_id_or_name

The id or url encoded name of the room

Valid length range: 1 - 100.

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

XMPP/Jabber ID of the room.

Required
object statistics

Statistics for this room.

Required
object links

URLs to retrieve more information

Required
string self

The URL to use to retrieve room statistics

Required
string name

Name of the room.

Required
object links

URLs to retrieve room information

Required
string self

The URL to use to retrieve the full room information

Required
string webhooks

The URL to use to retrieve webhooks registered for this room

Required
string members

The URL to use to retrieve members for this room. Only available for private rooms. Note this link will be made available to public room from Dec 1, 2016

string participants

The URL to use to retrieve participants for this room

Required
string created

Time the room was created in ISO 8601 format UTC.

Required
boolean is_archived

Whether or not this room is archived.

Required
string privacy

Privacy setting

Valid values: public, private.

Required
boolean is_guest_accessible

Whether or not guests can access this room.

Required
string avatar_url

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

May be null.

Required
boolean delegate_admin_visibility

Whether the room is visible to delegate admins, may be null to use the group default.

May be null.

Required
string topic

Current topic.

Required
array participants

List of current room participants, limited to 50 users. (Deprecated: Use the participants link.)

An array of the following objects.

Required
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 version

An etag-like random version string.

Required
object owner

The room owner.

Required
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
integer id

ID of the room.

Required
string guest_access_url

URL for guest access, if enabled.

May be null.

Required