How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Webex Users API

The Users API from Webex — 14 operation(s) for users.

Webex Users API is one of 193 APIs that Webex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 17 operations across 15 paths, and defines 43 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

17 operations 15 paths 43 schemas 10 GET4 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Authentication
OAuth 2.0, HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 5

Webex Users API declares 5 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow. It accepts HTTP bearer tokens (JWT) (bearer-key). It accepts HTTP bearer tokens (BEARER_TOKEN_FROM_CI). It accepts HTTP bearer tokens (JWT) (Bearer). It accepts HTTP bearer tokens (JWT) (bearerAuth).

  • bearer-key — e.g. Bearer YOURAUTHORIZATIONTOKEN
  • Bearer — e.g. Bearer YOURAUTHORIZATIONTOKEN
  • bearerAuth — JWT bearer token authentication. Obtain your token from the Webex Developer Portal.

Paths & Operations 17

Across 15 paths, the API surfaces 17 operations — 10 GET, 4 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Users 17
GET
/organization/{orgid}/userdeprecated
List Users
getAllConfigUser 6 params → 200401403404429500
PATCH
/organization/{orgid}/user/bulk
Bulk partial update Users
patchAllConfigUser 1 param body → 207400401403404429500
PATCH
/organization/{orgid}/user/bulk/update-dynamic-skill/{skillId}
Bulk partial update Users with dynamic skills
patchDynamicSkillsUser 2 params body → 207400401403404429500
GET
/organization/{orgid}/user/by-call-monitoring-id/{id}
List users by call monitoring id
getUsersByCallMonitoringIdUser 4 params → 200401403404429500
GET
/organization/{orgid}/user/by-ci-user-id/{id}deprecated
Get specific User by CI User ID
getUserByCiUserIdUser 4 params → 200401403404429500
GET
/organization/{orgid}/user/by-dynamic-skill-id/{skillId}
Get users by dynamic skill ID
getUsersByDynamicSkillIdUser 5 params → 200401403404429500
POST
/organization/{orgid}/user/fetch-by-skill-requirements
Get the agents matching skill requirements criteria
getUsersBySkillRequirementsUser 4 params body → 200400401403409429500
POST
/organization/{orgid}/user/fetch-user-details-by-ids
List Users with details
getUserdataByIdsUser 3 params body → 200400401403409429500
GET
/organization/{orgid}/user/with-user-profile
List Users along with profile
getAllUsersWithUserProfileUser 1 param → 200401403404429500
GET
/organization/{orgid}/user/with-user-profile/{id}
Get specific User along with profile by ID
getUserWithUserProfileUser 2 params → 200401403404429500
GET
/organization/{orgid}/user/{id}
Get specific User by ID
getConfigUser 9 params → 200401403404429500
PUT
/organization/{orgid}/user/{id}
Update specific User by ID
updateConfigUser 2 params body → 200400401403404412429500
PATCH
/organization/{orgid}/user/{id}
Partially update User by ID
patchConfigUser 2 params body → 200400401403404429500
GET
/organization/{orgid}/user/{id}/incoming-references
List references for a specific User
getIncomingReferencesUser 5 params → 200401403404429500
PATCH
/organization/{orgid}/user/{id}/reskill
Reskill Agents
reSkillAgentUser 2 params body → 204400401403404429500
GET
/organization/{orgid}/v2/user
List Users
getAllConfigWithPagedMetaDataUser 13 params → 200401403404429500
GET
/organization/{orgid}/v2/user/by-ci-user-id/{id}
Get specific User by CI User ID
getUserByCiUserIdWithUserProfileGranularAccessUser 5 params → 200401403404429500

Schemas 43

The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are UserResponseDTO (47 properties), UserResponseDTO_UserResponseWithUserProfile (46 properties), UserDTO (34 properties), UserProfileDTO (23 properties). Each schema is shown below with its type and property counts.

ResourceCollectionDTO
object
A collection of resources with their types and access levels.
9 properties 1 required
AssignedDynamicSkillsDTO
object
Data transfer object representing dynamic skills assigned to a user
12 properties 1 required
ResourceTypesDTO
object
A resource type with its access level and associated IDs.
3 properties 2 required
UserProfileAppFeatureDTO_UserResponseWithUserProfile
object
Data transfer object representing application feature access settings for a user profile
8 properties 2 required
MetaDataReferencesPagingInfo
object
Metadata of response for references with paging information
8 properties
UserWithSkillDetailsDTO
object
Data transfer object containing user information along with skill profile details
9 properties
BulkRequestItemDTOUpdateDynamicSkillsDTO
object
List of items in the bulk request.
3 properties
BulkRequestItemDTOUserDTO
object
List of items in the bulk request.
3 properties
QueueSkillRequirementDTO
object
Skill requirement for the queue
12 properties 3 required
UserDetailsResponseEnvelopeDTO
object
Response envelope containing user details data with metadata and pagination information
2 properties
UserDTO
object
User data transfer object for creating and updating user information in the contact center system
34 properties 7 required
UpdateDynamicSkillsDTO
object
Data transfer object for updating dynamic skills assigned to a user
11 properties
UserResponseDTO_UserResponseWithUserProfile
object
User response data transfer object containing user profile and configuration details
46 properties
ResponseEnvelopeUserDynamicSkillResponseDTO
object
Response Envelope User Dynamic Skill Response schema.
2 properties
EntityReferenceInfoDTO
object
3 properties
BulkResponseItemDTO
object
5 properties
QueuesCountDTO
object
The count of each type of Contact Service Queues that the user is assigned to.
3 properties
UserDetailsResponseDTO
object
Data transfer object containing detailed user information
4 properties
UserProfileAppFeatureDTO
object
Data transfer object representing application feature access settings for a user profile
8 properties 2 required
UserProfilePermissionsDTO
object
User Profile Permissions DTO
3 properties 1 required
EntityInfo
object
6 properties
MetaDataPagedUser
object
Meta Data Paged User schema.
9 properties
BulkRequestDTOUserDTO
object
Bulk Request User schema.
1 property
UserProfileDTO_UserResponseWithUserProfile
object
User profile data transfer object that defines access permissions and resource scope for contact center users
23 properties 8 required
UserDetailsRequestDTO
object
Get user details by a list of user IDs in the payload.
3 properties
UserProfileGranularAccessDTO
object
Data Transfer Object for creating or updating a user profile with granular access controls.
18 properties 5 required
DynamicSkills
object
Container for dynamic skills operations (add/remove)
2 properties
ErrorDetails
object
Details of an error.
2 properties
UserDynamicSkillResponseDTO
object
Response data transfer object containing user dynamic skill assignment information
6 properties
UserProfileAppModuleDTO_UserResponseWithUserProfile
object
User Profile App Module DTO
8 properties 2 required
BulkResponseDTO
object
1 property
PaginationLinks
object
5 properties 1 required
AssignedDynamicSkillsDTO_UserResponseWithUserProfile
object
Data transfer object representing dynamic skills assigned to a user
12 properties 1 required
ReSkillAgentRequestDTO
object
Request DTO for re-skilling an agent with a new skill profile and/or dynamic skills
7 properties
MetaDataWithPagingInfo
object
Metadata of response with paging information
6 properties
BulkRequestDTOUpdateDynamicSkillsDTO
object
Bulk Request Update Dynamic Skills schema.
1 property
UserProfileDTO
object
User profile data transfer object that defines access permissions and resource scope for contact center users
23 properties 8 required
UserResponseDTO
object
User response data transfer object containing user profile and configuration details
47 properties
UserProfileAppModuleDTO
object
User Profile App Module DTO
8 properties 2 required
ApiErrorResponse
object
Response body for an API error.
2 properties
QueuesCountDTO_UserResponseWithUserProfile
object
The count of each type of Contact Service Queues that the user is assigned to.
3 properties
JsonValue
object
Json Value schema.
1 property
OperationError
object
An error message providing details about the operation failure.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

webex-users-api-openapi.yml Raw ↑

Other APIs Webex publishes across the network.

Webex Address Book API
Webex Admin Audit Events API
Webex Agent Personal Greeting Files API
Webex Agent Summaries API
Webex Agent Wellbeing API
Webex Agents API
Webex AI Feature API
Webex API - Domain Management API
Webex Archive Users API
Webex Attachment Actions API
Webex Audio Files API
Webex Authorizations API
Where this information came from

This is an independent, third-party profile of Webex Users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.