People - List People | Webex for Developers

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 displayed for people within your organization or an organization you manage. Presence information will not be shown if the authenticated user has disabled status sharing.

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.

Long result sets will be split into pages.

GET/v1/people

Query Parameters

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.

string

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.

orgId

string

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

callingData

boolean

Include Webex Calling user details in the response.

Default: false

locationId

string

List people present in this location.

max

number

Limit the maximum number of people in the response.

Default: 100

Response Properties

items

array[Person]

An array of person objects.

string

A unique identifier for the person.

emails

array[string]

The email addresses of the person.

phoneNumbers

array[object]

Phone numbers for the person.

type

enum

The type of phone number.

Possible values: work, mobile, fax

value

string

The phone number.

Possible values: +1 408 526 7209

extension

string

The Webex Calling extension for the person. Only applies to a person with a Webex Calling license

locationId

string

The ID of the location for this person retrieved from BroadCloud.

displayName

string

The full name of the person.

nickName

string

The nickname of the person if configured. If no nickname is configured for the person, this field will not be present.

firstName

string

The first name of the person.

lastName

string

The last name of the person.

avatar

string

The URL to the person's avatar in PNG format.

orgId

string

The ID of the organization to which this person belongs.

roles

array[string]

An array of role strings representing the roles to which this person belongs.

licenses

array[string]

An array of license strings allocated to this person.

created

string

The date and time the person was created.

lastModified

string

The date and time the person was last changed.

timezone

string

The time zone of the person if configured. If no timezone is configured on the account, this field will not be present

lastActivity

string

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.

siteUrls

array[string]

One or several site names where this user has a role (host or attendee)

sipAddresses

array[{"type": "personal-room","value": "testuser5@mycompany.webex.com","primary": false}]

The users sip addresses

status

enum

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.

active

string

active within the last 10 minutes

call

string

the user is in a call

DoNotDisturb

string

the user has manually set their status to "Do Not Disturb"

inactive

string

last activity occurred more than 10 minutes ago

meeting

string

the user is in a meeting

OutOfOffice

string

the user or a Hybrid Calendar service has indicated that they are "Out of Office"

pending

string

the user has never logged in; a status cannot be determined

presenting

string

the user is sharing content

unknown

string

the user’s status could not be determined

invitePending

enum

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.

true

string

the person has been invited to Webex but has not created an account

false

string

an invite is not pending for this person

loginEnabled

enum

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.

true

string

the person can log into Webex

false

string

the person cannot log into Webex

type

enum

The type of person account, such as person or bot.

person

string

account belongs to a person

bot

string

account is a bot user

appuser

string

account is a guest user

notFoundIds

array[string]

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.
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.

GET

/v1/people{?email,displayName,id,orgId,callingData,locationId,max}

Header

Authorization
Use personal access token
Bearer
This limited-duration personal access token is hidden for your security.

Query Parameters

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. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.
orgId
string
List people in this organization. Only admin users of another organization (such as partners) may use this parameter.
callingData
boolean
Include Webex Calling user details in the response.
locationId
string
List people present in this location.
max
number
Limit the maximum number of people in the response.

https://webexapis.com/v1/people?email=john.andersen@example.com&displayName=John%20Andersen&id=Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY&orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE&callingData=true&locationId=Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzYzNzE1&max=100

200 / OK

{
  "items": [
    {
      "id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
      "emails": [
        "john.andersen@example.com"
      ],
      "phoneNumbers": [
        {
          "type": "work",
          "value": "+1 408 526 7209"
        }
      ],
      "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"
      ],
      "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": [
        {}
      ],
      "status": "active",
      "invitePending": "false",
      "loginEnabled": "true",
      "type": "person"
    }
  ],
  "notFoundIds": []
}