Webex Users API
The Users API from Webex — 14 operation(s) for users.
Webex Users API is one of 178 APIs that Webex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Users. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 16 operations across 14 paths, and defines 50 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.
16 operations
14 paths
50 schemas
9 GET4 PATCH2 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Webex Users API declares
3 security schemes
for authenticating requests.
It supports OAuth 2.0 (oauth2) using the authorizationCode flow.
It accepts HTTP bearer tokens (JWT) (bearer-key).
It supports OAuth 2.0 (bearerAuth) using the authorizationCode flow, exposing 1 scope.
bearer-key— e.g. Bearer YOURAUTHORIZATIONTOKENbearerAuth— OAuth 2.0 Bearer token authentication
Paths & Operations 16
Across 14 paths, the API surfaces 16 operations — 9 GET, 4 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Users 16
GET
/organization/{orgid}/userdeprecated
List User(s)
PATCH
/organization/{orgid}/user/bulk
Bulk partial update Users
PATCH
/organization/{orgid}/user/bulk/update-dynamic-skill/{skillId}
Bulk update User dynamic skills
GET
/organization/{orgid}/user/by-ci-user-id/{id}
Get specific User by CI User ID
GET
/organization/{orgid}/user/by-dynamic-skill-id/{skillId}
Get users by dynamic skill ID
POST
/organization/{orgid}/user/fetch-by-skill-requirements
Get the agents matching skill requirements criteria
POST
/organization/{orgid}/user/fetch-user-details-by-ids
Fetch User details by IDs
GET
/organization/{orgid}/user/with-user-profile
List Users along with profile
GET
/organization/{orgid}/user/with-user-profile/{id}
Get specific User along with profile by ID
GET
/organization/{orgid}/user/{id}
Get specific User by ID
PUT
/organization/{orgid}/user/{id}
Update specific User by ID
PATCH
/organization/{orgid}/user/{id}
Partially update User by ID
GET
/organization/{orgid}/user/{id}/incoming-references
List references for a specific User
PATCH
/organization/{orgid}/user/{id}/reskill
Reskill Agents
GET
/organization/{orgid}/v2/user
List User(s)
GET
/organization/{orgid}/v2/user/by-ci-user-id/{id}
Get specific User by CI User ID
Schemas 50
The contract defines 50 schemas that model the data the API accepts and returns. The most detailed are UserResponseDTO (45 properties), UserResponseDTO_UserResponseWithUserProfileGranularAccess (44 properties), UserResponseDTO_UserResponseWithUserProfile (44 properties), UserDTO (32 properties). Each schema is shown below with its type and property counts.
UserProfilePermissionsDTO
object
User Profile Permissions DTO
3 properties
1 required
UserProfileAppFeatureDTO
object
8 properties
2 required
ApiErrorResponse
object
Response body for an API error.
2 properties
UserProfileDTO_UserResponseWithUserProfile
object
Details of UserProfile which a Contact Center administrator has configured for the user.This is an optional object, returned only when the endpoint 'Get User a…
23 properties
8 required
ReSkillAgentRequestDTO
object
7 properties
ResourceTypesDTO
object
A resource type with its access level and associated IDs.
3 properties
2 required
UserDynamicSkillResponseDTO
object
The response object for a user's dynamic skill details.
6 properties
UserProfilePermissionsDTO_UserResponseWithUserProfileGranularAccess
object
User Profile Permissions DTO
3 properties
1 required
UserProfileGranularAccessDTO
object
Data Transfer Object for creating or updating a user profile with granular access controls.
18 properties
5 required
UserDetailsResponseEnvelopeDTO
object
The response envelope for user details operations.
2 properties
AssignedDynamicSkillsDTO
object
11 properties
1 required
BulkRequestDTOUserDTO
object
The request body for bulk user operations.
1 property
PaginationLinks
object
5 properties
1 required
QueueSkillRequirementDTO
object
Skill requirement for the queue
12 properties
3 required
EntityInfo
object
6 properties
ResourceCollectionDTO_UserResponseWithUserProfileGranularAccess
object
A collection of resources with their types and access levels.
9 properties
1 required
UserProfileAppModuleDTO
object
User Profile App Module DTO
8 properties
2 required
ResponseEnvelopeUserDynamicSkillResponseDTO
object
The response envelope for user dynamic skill operations.
2 properties
DynamicSkills
object
2 properties
UserResponseDTO
object
The response object representing a user in the contact center.
45 properties
BulkResponseItemDTO
object
5 properties
BulkRequestDTOUpdateDynamicSkillsDTO
object
The request body for bulk dynamic skills update operations.
1 property
OperationError
object
An error message providing details about the operation failure.
1 property
UserWithSkillDetailsDTO
object
The user details including skill information.
9 properties
JsonValue
object
1 property
UserDetailsResponseDTO
object
The response object containing detailed user information.
4 properties
UserResponseDTO_UserResponseWithUserProfileGranularAccess
object
The response object representing a user with user profile and granular access details.
44 properties
AssignedDynamicSkillsDTO_UserResponseWithUserProfile
object
The list of dynamic skills associated with the user
11 properties
1 required
ErrorDetails
object
Details of an error.
2 properties
QueuesCountDTO_UserResponseWithUserProfile
object
The count of each type of Contact Service Queues that the user is assigned to.
3 properties
MetaDataPagedUser
object
9 properties
BulkRequestItemDTOUserDTO
object
List of items in the bulk request.
3 properties
UserDetailsRequestDTO
object
Get User Details by list of user ids payload
3 properties
BulkResponseDTO
object
1 property
UserProfileGranularAccessDTO_UserResponseWithUserProfileGranularAccess
object
Data Transfer Object for creating or updating a user profile with granular access controls.
18 properties
5 required
QueuesCountDTO_UserResponseWithUserProfileGranularAccess
object
The count of each type of Contact Service Queues that the user is assigned to.
3 properties
MetaDataWithPagingInfo
object
Metadata of response with paging information
6 properties
BulkRequestItemDTOUpdateDynamicSkillsDTO
object
List of items in the bulk request.
3 properties
UserProfileAppModuleDTO_UserResponseWithUserProfile
object
User Profile App Module DTO
8 properties
2 required
UpdateDynamicSkillsDTO
object
The request object for updating dynamic skills for a user.
11 properties
EntityReferenceInfoDTO
object
3 properties
UserProfileDTO
object
Details of UserProfile which a Contact Center administrator has configured for the user.This is an optional object, returned only when the endpoint 'Get User a…
23 properties
8 required
UserProfileAppFeatureDTO_UserResponseWithUserProfile
object
The user profile application feature settings with user profile details.
8 properties
2 required
UserDTO
object
The request object for creating or updating a user in the contact center.
32 properties
7 required
QueuesCountDTO
object
The count of each type of Contact Service Queues that the user is assigned to.
3 properties
ResourceCollectionDTO
object
A collection of resources with their types and access levels.
9 properties
1 required
ResourceTypesDTO_UserResponseWithUserProfileGranularAccess
object
A resource type with its access level and associated IDs.
3 properties
2 required
AssignedDynamicSkillsDTO_UserResponseWithUserProfileGranularAccess
object
The list of dynamic skills associated with the user
11 properties
1 required
MetaDataReferencesPagingInfo
object
Metadata of response for references with paging information
8 properties
UserResponseDTO_UserResponseWithUserProfile
object
The response object representing a user with user profile details.
44 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Webex 12
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
#Users