API Reference version 2

Get room glance

GET/v2/room/{room_id_or_name}/extension/glance/{key}

Retrieve a glance/

Path parameters

Type Parameter Description Required?
string key

Unique key (in the context of the integration) to identify this glance.

Valid length range: 1 - 40.

Required
string room_id_or_name

The id of the room

Valid length range: 1 - 100.

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

The display name of the glance.

Required
integer weight

Determines the order in which glances appear. Glances are displayed top to bottom in order of ascending weight.

Required
object room

The room, if specified, that this glance is restricted to. Will be null for global extensions

May be null.

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 privacy

Privacy setting

Valid values: public, private.

Required
boolean is_archived

Whether or not this room is archived.

Required
string version

An etag-like random version string.

Required
integer id

ID of the room.

Required
object conditions

Conditions determine whether this glance is shown

string created

Time the glance was created in in ISO 8601 format UTC.

Required
string key

Unique key (in the context of the integration) to identify this glance.

Required
string queryUrl

The URL of the resource providing the glance content.

object target

Defines the behaviour when clicking on the glance.

object options

An object containing options which vary based on the type of target.

string key

The key of a dialog, glance or web panel that should be opened in response to this action.

Valid length range: 1 - 40.

Required
integer id

Internal ID of the extension.

Required
object icon

Icon to display on the left side of the glance.

Required
string url

Url for the icon.

Required
string url@2x

Url for the retina version of the icon.

Required