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.
Response properties associated with a user's presence status, such as status or lastActivity, will only be returned for people within your organization or an organization you manage. Presence information will not be returned if the authenticated user has disabled status sharing. Calling /people frequently to poll status information for a large set of users will quickly lead to 429 errros and throttling of such requests and is therefore discouraged.
Admin users can include Webex Calling (BroadCloud) user details in the response by specifying callingData parameter as true. Admin users can list all users in a location or with a specific phone number. Admin users will receive an enriched payload with additional administrative fields like licenses,roles, locations etc. These fields are shown when accessing a user via GET /people/{id}, not when doing a GET /people?id=
Lookup by email is only supported for people within the same org or where a partner admin relationship is in place.
Lookup by roles is only supported for Admin users for the people within the same org.
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. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.
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. If this parameter is provided then presence information (such as the lastActivity or status properties) will not be included in the response.
List people in this organization. Only admin users of another organization (such as partners) may use this parameter.
List of roleIds separated by commas.
Include Webex Calling user details in the response.
List people present in this location.
Limit the maximum number of people in the response. If callingData=true, then max will not be more than 100. If locationId is specified then max will not be more than 50.
Response Properties
An array of person objects.
A unique identifier for the person.
The email addresses of the person.
Phone numbers for the person.
The type of phone number.
Work phone number of the person.
Work extension of the person. For the Webex Calling person, the value will have a routing prefix along with the extension.
Mobile number of the person.
FAX number of the person.
The phone number.
Primary number for the person.
The Webex Calling extension for the person. Only applies to a person with a Webex Calling license.
The ID of the location for this person retrieved from BroadCloud.
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 admin user belongs.
An array of license strings allocated to this person.
The business department the user belongs to.
A manager identifier.
Person ID of the manager.
The person's title.
A person's addresses.
The type of address.
The user's country.
The user's locality, often city.
The user's region, often state.
The user's street.
The user's postal or zip code.
The date and time the person was created.
The date and time the person was last changed.
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. This will only be returned for people within your organization or an organization you manage. Presence information will not be shown if the authenticated user has disabled status sharing.
One or several site names where this user has a role (host or attendee).
The user's SIP addresses. Read-only.
The type of SIP address.
Personal room address.
Enterprise address.
Cloud calling address.
The SIP address.
Primary SIP address of the person.
Identifier for intra-domain federation with other XMPP based messenger systems.
The current presence status of the person. This will only be returned for people within your organization or an organization you manage. Presence information will not be shown if the authenticated user has disabled status sharing. Presence status is different from Control Hub's "Last Service Access Time" which indicates the last time an oAuth token was issued for this user.
Active within the last 10 minutes.
The user is in a call.
The user has manually set their status to "Do Not Disturb".
Last activity occurred more than 10 minutes ago.
The user is in a meeting.
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 is sharing content.
The user’s status could not be determined.
Whether or not an invite is pending for the user to complete account activation. This property is only returned if the authenticated user is an admin user for the person's organization.
The person has been invited to Webex but has not created an account.
An invite is not pending for this person.
Whether or not the user is allowed to use Webex. This property is only returned if the authenticated user is an admin user for the person's organization.
The person can log into Webex.
The person cannot log into Webex.
The type of person account, such as person or bot.
Account belongs to a person.
Account is a bot user.
Account is a guest user.
An array of person IDs that could not be found.
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. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 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. |
| 410 | Gone | The requested resource is no longer available. |
| 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. |
| 423 | Locked | The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 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. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
Query Parameters
- List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.
- 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. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.
- List people in this organization. Only admin users of another organization (such as partners) may use this parameter.
- List of roleIds separated by commas.
- Include Webex Calling user details in the response.
- List people present in this location.
- Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.
{
"items": [
{
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"emails": [
"john.andersen@example.com"
],
"phoneNumbers": [
{
"type": "work",
"value": "+1 408 526 7209",
"primary": true
}
],
"extension": "133",
"locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzYzNzE1",
"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"
],
"department": "Sales",
"manager": "John Duarte",
"managerId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS80ZGEzYTI0OC05YjBhLTQxMDgtODU0NC1iNTQwMzEyZTU2M2E",
"title": "GM",
"addresses": [
{
"type": "work",
"country": "US",
"locality": "Milpitas",
"region": "California",
"streetAddress": "1099 Bird Ave.",
"postalCode": "99212"
}
],
"created": "2015-10-18T14:26:16.000Z",
"lastModified": "2015-10-18T14:26:16.000Z",
"timezone": "America/Denver",
"lastActivity": "2015-10-18T14:26:16.028Z",
"siteUrls": [
"mysite.webex.com#attendee"
],
"sipAddresses": [
{
"type": "personal-room",
"value": "testuser5@mycompany.webex.com",
"primary": false
}
],
"xmppFederationJid": "user@example.com",
"status": "active",
"invitePending": "false",
"loginEnabled": "true",
"type": "person"
}
],
"notFoundIds": []
}