List People

List people in your organization. For most users, either the email or displayName parameter is required. Admin users can omit these fields and list all users in their organization.

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
email string

List people with this email address. For non-admin requests, either this or displayName are required.

displayName string

List people whose name starts with this string. For non-admin requests, either this or email are required.

id string

List people by ID. Accepts up to 85 person IDs separated by commas.

orgId string

List people in this organization. Only admin users of another organization (such as partners) may use this parameter.

max integer

Limit the maximum number of people in the response.

Query Parameters

Name Type Your values
email string
displayName string
id string
orgId 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.