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.
Query Parameters
List people with this email address. For non-admin requests, either this or displayName are required.
List people whose name starts with this string. For non-admin requests, either this or email are required.
List people by ID. Accepts up to 85 person IDs separated by commas.
List people in this organization. Only admin users of another organization (such as partners) may use this parameter.
Limit the maximum number of people in the response.
Response Properties
A unique identifier for the person.
The email addresses of the person.
Phone numbers for the person.
The full name of the person.
The nickname of the person if configured. If no nickname is configured for the person, this field will not be present.
The first name of the person.
The last name of the person.
The URL to the person's avatar in PNG format.
The ID of the organization to which this person belongs.
An array of role strings representing the roles to which this person belongs.
An array of license strings allocated to this person.
The date and time the person was created.
The time zone of the person if configured. If no timezone is configured on the account, this field will not be present
The date and time of the person's last activity within Webex Teams.
The current presence status of the person.
active within the last 10 minutes
the user has manually set their status to "Do Not Disturb"
last activity occurred more than 10 minutes ago
the user or a Hybrid Calendar service has indicated that they are "Out of Office"
the user has never logged in; a status cannot be determined
the user’s status could not be determined
Whether or not an invite is pending for the user to complete account activation.
the person has been invited to Webex Teams but has not created an account
an invite is not pending for this person
Whether or not the user is allowed to use Webex Teams.
the person can log into Webex Teams
the person cannot log into Webex Teams
The type of person account, such as person or bot.
account belongs to a person
account is a bot user
Response Codes
The list below describes the common success and error responses you should expect from the API.
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | 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. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | 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. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 429 | Too Many Requests | 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. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
Header
Query Parameters
- List people with this email address. For non-admin requests, either this or `displayName` are required.
- List people whose name starts with this string. For non-admin requests, either this or email are required.
- List people by ID. Accepts up to 85 person IDs separated by commas.
- List people in this organization. Only admin users of another organization (such as partners) may use this parameter.
- Limit the maximum number of people in the response.
{
"items": [
{
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"emails": [
"john.andersen@example.com"
],
"phoneNumbers": [
{
"type": "work",
"value": "+1 408 526 7209"
}
],
"displayName": "John Andersen",
"nickName": "John",
"firstName": "John",
"lastName": "Andersen",
"avatar": "https://1efa7a94ed21783e352-c62266528714497a17239ececf39e9e2.ssl.cf1.rackcdn.com/V1~54c844c89e678e5a7b16a306bc2897b9~wx29yGtlTpilEFlYzqPKag==~1600",
"orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"roles": [
"Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh",
"Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi"
],
"licenses": [
"Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh",
"Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi"
],
"created": "2015-10-18T14:26:16.000Z",
"timezone": "America/Denver",
"lastActivity": "2015-10-18T14:26:16.028Z",
"status": "active",
"invitePending": "false",
"loginEnabled": "true",
"type": "person"
}
]
}