List Memberships

Lists all room memberships. By default, lists memberships for rooms to which the authenticated user belongs.

Use query parameters to filter the response.

Use roomId to list memberships for a room, by ID.

Use either personId or personEmail to filter the results.

Long result sets will be split into pages.

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

Request Headers

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

Query Parameters

Name Type Description
roomId string

Limit results to a specific room, by ID.

personId string

Limit results to a specific person, by ID.

personEmail string

Limit results to a specific person, by email address.

max integer

Limit the maximum number of items in the response.

Query Parameters

Name Type Your values
roomId string
personId string
personEmail string
max integer

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.