List Rooms

List rooms.

By default, lists rooms to which the authenticated user belongs.

You're not logged in. to run the demo.

Request Headers

Content-type application/json; charset=utf-8

Query Parameters

Name Type Description
teamId string

Limit the rooms to those associated with a team, by ID.

max integer

Limit the maximum number of rooms in the response.

type string

Available values: direct and group. direct returns all 1-to-1 rooms. group returns all group rooms. If not specified or values not matched, will return all room types.

sortBy string

Available values: id, lastactivity, created.

Sort results by room ID (id), most recent activity (lastactivity), or most recently created (created).

Query Parameters

Name Type Your values
teamId string
max integer
type string
sortBy string

Response Codes




The request was invalid or cannot be otherwise served. An accompanying error message will explain further.


Authentication credentials were missing or incorrect.


The request is understood, but it has been refused or access is not allowed.


The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.


The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.


Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.


Something went wrong on the server.


Server is overloaded with requests. Try again later.