openapi: 3.2.0
info:
title: Webex People API
version: 1.0.0
description: 'Operations tagged People across 5 of this provider''s published API definitions: webex-admin-openapi.json,
webex-cloud-calling-openapi.json, webex-meeting-openapi.json, webex-messaging-openapi.json, webex-people-api-openapi.yml.
Each path carries the servers of the definition it was published in.'
x-provenance:
method: harvested
authored_by: Cisco Webex
harvested_by: API Evangelist
harvested_on: '2026-08-19'
first_party: true
note: Published by Cisco. Retrieved unmodified except for this x-provenance block.
provider_published: true
derived_view: Per-tag view of webex-admin-openapi.json, the provider's source document. Operations and schemas are the
provider's, unmodified; only the partition is ours.
derived_from: webex-admin-openapi.json
operation_coverage: 6/6
x-evidence:
- type: source
url: https://github.com/webex/webex-openapi-specs/blob/main/public-spec/webex-admin.json
- type: raw
url: https://raw.githubusercontent.com/webex/webex-openapi-specs/main/public-spec/webex-admin.json
tags:
- name: People
paths:
/people:
get:
responses:
'200':
description: OK
headers:
Link:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/PersonCollectionResponse'
example:
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: []
'400':
description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message
will explain further.'
'401':
description: 'Unauthorized: Authentication credentials were missing or incorrect.'
'403':
description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
'404':
description: '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':
description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
'409':
description: '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':
description: 'Gone: The requested resource is no longer available.'
'415':
description: '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':
description: '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':
description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
'429':
description: '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':
description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact
the [Webex Developer Support team](/explore/support).'
'502':
description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the
request. Try again later.'
'503':
description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
'504':
description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please
try to reduce it.'
summary: List People
operationId: List People
description: '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](https://help.webex.com/nkzs6wl/). Calling /people frequently to poll
`status` information for a large set of users will quickly lead to `429` errors 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. 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](/docs/basics#pagination).'
tags:
- People
parameters:
- name: email
in: query
description: 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.
example: john.andersen@example.com
schema:
type: string
- name: displayName
in: query
description: List people whose name starts with this string. For non-admin requests, either this or email are required.
example: John Andersen
schema:
type: string
- name: id
in: query
description: 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.
example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY
schema:
type: string
- name: orgId
in: query
description: List people in this organization. Only admin users of another organization (such as partners) may use
this parameter.
example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
schema:
type: string
- name: roles
in: query
description: List of roleIds separated by commas.
example: Y2lzY29zcGFyazovL3VzL1JPTEUvYXRsYXMtcG9ydGFsLnBhcnRuZXIuc2FsZXNhZG1pbg
schema:
type: string
- name: callingData
in: query
description: Include Webex Calling user details in the response.
example: true
schema:
type: boolean
default: false
- name: locationId
in: query
description: List people present in this location.
example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzYzNzE1
schema:
type: string
- name: max
in: query
description: 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.
example: 100
schema:
type: number
default: 100
- name: excludeStatus
in: query
description: Omit people status/availability to enhance query performance.
example: true
schema:
type: boolean
default: false
post:
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Person'
example:
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
'400':
description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message
will explain further.'
'401':
description: 'Unauthorized: Authentication credentials were missing or incorrect.'
'403':
description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
'404':
description: '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':
description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
'409':
description: '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':
description: 'Gone: The requested resource is no longer available.'
'415':
description: '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':
description: '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':
description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
'429':
description: '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':
description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact
the [Webex Developer Support team](/explore/support).'
'502':
description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the
request. Try again later.'
'503':
description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
'504':
description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please
try to reduce it.'
summary: Create a Person
operationId: Create a Person
description: 'Create a new user account for a given organization. Only an admin can create a new user account.
At least one of the following body parameters is required to create a new user: `displayName`, `firstName`, `lastName`.
Currently, users may have only one email address associated with their account. The `emails` parameter is an array,
which accepts multiple values to allow for future expansion, but currently only one email address will be used for
the new user.
Admin users can include `Webex calling` (BroadCloud) user details in the response by specifying `callingData` parameter
as true. It may happen that the POST request with calling data returns a 400 status, but the person was created still.
One way to get into this state is if an invalid phone number is assigned to a user. The people API aggregates calls
to several other microservices, and one may have failed. A best practice is to check if the user exists before retrying.
This can be done with the user''s email address and a GET /people.
When doing attendee management, append `#attendee` to the `siteUrl` parameter (e.g. `mysite.webex.com#attendee`) to
make the new user an attendee for a site.
**NOTES**:
* For creating a `Webex Calling` user, you must provide `phoneNumbers` or `extension`, `locationId`, and `licenses`
string in the same request.
* `SipAddresses` are asigned via an asynchronous process. This means that the POST response may not show the SIPAddresses
immediately. Instead you can verify them with a separate GET to /people, after they were newly configured.
* When assigning multiple licenses in a single request, the system will assign all valid and available licenses. If
any requested licenses cannot be assigned, the operation will continue with the remaining licenses. As a result, it
is possible that not all requested licenses are assigned to the user.'
tags:
- People
parameters:
- name: callingData
in: query
description: Include Webex Calling user details in the response.
example: true
schema:
type: boolean
default: false
- name: minResponse
in: query
description: Set to `true` to improve performance by omitting person details and returning only the ID in the response
when successful. If unsuccessful the response will have optional error details.
example: true
schema:
type: boolean
default: false
requestBody:
content:
application/json:
example:
emails:
- john.andersen@example.com
phoneNumbers:
- type: work
value: 408 526 7209
extension: '133'
locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzYzNzE1
displayName: John Andersen
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'
siteUrls:
- mysite.webex.com#attendee
schema:
type: object
required:
- emails
properties:
emails:
type: array
items:
type: string
example: john.andersen@example.com
description: The email addresses of the person. Only one email address is allowed per person.
phoneNumbers:
type: array
items:
type: object
properties:
type:
type: string
enum:
- work
description: The type of phone number.
value:
type: string
example: 408 526 7209
description: The phone number.
description: Phone numbers for the person. Only settable for Webex Calling. Requires a Webex Calling license.
extension:
type: string
example: '133'
description: Webex Calling extension of the person. This is only settable for a person with a Webex Calling
license.
locationId:
type: string
example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzYzNzE1
description: The ID of the location for this person.
displayName:
type: string
example: John Andersen
description: The full name of the person.
firstName:
type: string
example: John
description: The first name of the person.
lastName:
type: string
example: Andersen
description: The last name of the person.
avatar:
type: string
example: https://1efa7a94ed21783e352-c62266528714497a17239ececf39e9e2.ssl.cf1.rackcdn.com/V1~54c844c89e678e5a7b16a306bc2897b9~wx29yGtlTpilEFlYzqPKag==~1600
description: The URL to the person's avatar in PNG format.
orgId:
type: string
example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
description: The ID of the organization to which this person belongs.
roles:
type: array
items:
type: string
example: Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh,Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi
description: An array of role strings representing the roles to which this admin user belongs.
licenses:
type: array
items:
type: string
example: Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh,Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi
description: An array of license strings allocated to this person.
department:
type: string
example: Sales
description: The business department the user belongs to.
manager:
type: string
example: John Duarte
description: A manager identifier.
managerId:
type: string
example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS80ZGEzYTI0OC05YjBhLTQxMDgtODU0NC1iNTQwMzEyZTU2M2E
description: Person ID of the manager.
title:
type: string
example: GM
description: The person's title.
addresses:
type: array
items:
type: object
properties:
type:
type: string
example: work
description: The type of address.
country:
type: string
example: US
description: The user's country.
locality:
type: string
example: Milpitas
description: The user's locality, often city.
region:
type: string
example: California
description: The user's region, often state.
streetAddress:
type: string
example: 1099 Bird Ave.
description: The user's street.
postalCode:
type: string
example: '99212'
description: The user's postal or zip code.
description: A person's addresses.
siteUrls:
type: array
items:
type: string
example: mysite.webex.com#attendee
description: 'One or several site names where this user has an attendee role. Append `#attendee` to the
sitename (e.g.: `mysite.webex.com#attendee`).'
/people/{personId}:
get:
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Person'
example:
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
'400':
description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message
will explain further.'
'401':
description: 'Unauthorized: Authentication credentials were missing or incorrect.'
'403':
description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
'404':
description: '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':
description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
'409':
description: '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':
description: 'Gone: The requested resource is no longer available.'
'415':
description: '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':
description: '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':
description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
'429':
description: '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':
description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact
the [Webex Developer Support team](/explore/support).'
'502':
description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the
request. Try again later.'
'503':
description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
'504':
description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please
try to reduce it.'
summary: Get Person Details
operationId: Get Person Details
description: 'Shows details for a person, by ID.
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](https://help.webex.com/nkzs6wl/).
Admin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter
as `true`.
Specify the person ID in the `personId` parameter in the URI.'
tags:
- People
parameters:
- name: personId
in: path
description: A unique identifier for the person.
required: true
example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY
schema:
type: string
- name: callingData
in: query
description: Include Webex Calling user details in the response.
example: true
schema:
type: boolean
default: false
put:
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Person'
example:
id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY
emails:
- john.andersen@example.com
phoneNumbers:
- type: work
value: +1 408 526 7209
primary: true
extension: '
# --- truncated at 32 KB (68 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/webex/refs/heads/main/openapi/webex-people-api-openapi.yml