Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Webex Desktop Profile API

The Desktop Profile API from Webex — 7 operation(s) for desktop profile.

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

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

This API exposes 10 operations across 7 paths, and defines 20 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

10 operations 7 paths 20 schemas 1 DELETE5 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 3

Webex Desktop Profile 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 YOURAUTHORIZATIONTOKEN
  • bearerAuth — OAuth 2.0 Bearer token authentication

Paths & Operations 10

Across 7 paths, the API surfaces 10 operations — 1 DELETE, 5 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Desktop Profile 10
GET
/organization/{orgid}/agent-profile
List Desktop Profile(s)
getAllConfig_14 6 params → 200401403404429500
POST
/organization/{orgid}/agent-profile
Create a new Desktop Profile
createConfig_28 1 param body → 201400401403409429500
POST
/organization/{orgid}/agent-profile/bulk
Bulk save Desktop Profile(s)
saveAllConfig_24 1 param body → 207400401403409429500
GET
/organization/{orgid}/agent-profile/bulk-exportdeprecated
Bulk export Desktop Profile(s)
bulkExport_21 3 params → 200401403404429500
POST
/organization/{orgid}/agent-profile/purge-inactive-entities
Purge inactive Desktop Profile(s)
purgeInactiveConfig_11 2 params → 200400401403409429500
GET
/organization/{orgid}/agent-profile/{id}
Get specific Desktop Profile by ID
getConfig_28 2 params → 200401403404429500
PUT
/organization/{orgid}/agent-profile/{id}
Update specific Desktop Profile by ID
updateConfig_28 2 params body → 200400401403404412429500
DELETE
/organization/{orgid}/agent-profile/{id}
Delete specific Desktop Profile by ID
deleteConfig_25 2 params → 204401403404412429500
GET
/organization/{orgid}/agent-profile/{id}/incoming-references
List references for a specific Desktop Profile
getIncomingReferences_20 5 params → 200401403404429500
GET
/organization/{orgid}/v2/agent-profile
List Desktop Profile(s)
getAllConfigWithMetaData_26 7 params → 200401403404429500

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are AgentProfileDTO (47 properties), AgentProfileResponseDTO (47 properties), AgentProfileBulkExportDTO (43 properties), ViewableStatisticsDTO (11 properties). Each schema is shown below with its type and property counts.

Response
object
3 properties
ApiErrorResponse
object
Response body for an API error.
2 properties
viewableStatistics
object
11 properties 2 required
BulkRequestDTOAgentProfileDTO
object
1 property
Link
object
8 properties
EntityInfo
object
6 properties
BulkResponseItemDTO
object
5 properties
AgentProfileBulkExportDTO
object
43 properties 10 required
AgentProfileDTO
object
47 properties 10 required
OperationError
object
An error message providing details about the operation failure.
1 property
ViewableStatisticsDTO
object
Specifies the Statistics that agent of this profile can view.
11 properties 2 required
SiteTeamPairDTO
object
2 properties
ErrorDetails
object
Details of an error.
2 properties
BulkExportDTOAgentProfileBulkExportDTO
object
5 properties
BulkResponseDTO
object
1 property
MetaDataWithPagingInfo
object
Metadata of response with paging information
6 properties
EntityReferenceInfoDTO
object
3 properties
AgentProfileResponseDTO
object
47 properties 9 required
MetaDataReferencesPagingInfo
object
Metadata of response for references with paging information
8 properties
BulkRequestItemDTOAgentProfileDTO
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

webex-desktop-profile-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