API Reference version 2

Get auto join rooms

GET/v2/user/{id_or_email}/preference/auto-join

Get the list of rooms a user joins when they log in.

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

Path parameters

Type Parameter Description Required?
string id_or_email

The id, email address, or mention name (beginning with an '@') of the user to retrieve rooms.

Required

Query parameters

Type Parameter Description Required?
integer start-index

The start index for the result set

Defaults to 0.

integer max-results

The maximum number of results.

Valid length range: 0 - 1000.

Defaults to 100.

200 application/json
Type Property Description Required?
array items

An array of the following objects.

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
integer startIndex

The start index for this set of results.

Required
integer maxResults

The maximum number of results returned.

Valid length range: 1 - 1000.

Required
object links

An object with the following properties.

Required
string self

The URL for this resource.

Required
string prev

The URL to retrieve the previous set of results.

string next

The URL to retrieve the next page of results.