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 Layout API

The Desktop Layout API from Webex — 7 operation(s) for desktop layout.

Webex Desktop Layout 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 Layout. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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

9 operations 7 paths 16 schemas 1 DELETE4 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 Layout 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 9

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

Desktop Layout 9
POST
/organization/{orgid}/desktop-layout
Create a new Desktop Layout
createConfig_15 1 param body → 200400401403409429500
POST
/organization/{orgid}/desktop-layout/bulk
Bulk save Desktop Layout(s)
saveAllConfig_15 1 param body → 207400401403409429500
GET
/organization/{orgid}/desktop-layout/bulk-exportdeprecated
Bulk export Desktop Layout(s)
bulkExport_13 3 params → 200401403404429500
POST
/organization/{orgid}/desktop-layout/purge-inactive-entities
Purge inactive Desktop Layout(s)
purgeInactiveConfig_7 2 params → 200400401403409429500
GET
/organization/{orgid}/desktop-layout/{id}
Get specific Desktop Layout by ID
getConfig_17 2 params → 200401403404429500
PUT
/organization/{orgid}/desktop-layout/{id}
Update specific Desktop Layout by ID
updateConfig_17 2 params body → 200400401403404412429500
DELETE
/organization/{orgid}/desktop-layout/{id}
Delete specific Desktop Layout by ID
deleteConfig_15 2 params → 200401403404412429500
GET
/organization/{orgid}/desktop-layout/{id}/incoming-references
List references for a specific Desktop Layout
getIncomingReferences_13 5 params → 200401403404429500
GET
/organization/{orgid}/v2/desktop-layout
List Desktop Layout(s)
getAllConfigWithMetaData_16 8 params → 200401403404429500

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are DesktopLayoutDTO (19 properties), MetaDataReferencesPagingInfo (8 properties), Link (8 properties), EntityInfo (6 properties). Each schema is shown below with its type and property counts.

DesktopLayoutDTO
object
19 properties 8 required
Response
object
3 properties
ApiErrorResponse
object
Response body for an API error.
2 properties
Link
object
8 properties
ErrorDetails
object
Details of an error.
2 properties
BulkResponseItemDTO
object
5 properties
ResponseEnvelopeDesktopLayoutDTO
object
2 properties
DesktopLayoutBulkExportDTO
object
5 properties
OperationError
object
An error message providing details about the operation failure.
1 property
BulkRequestDTODesktopLayoutDTO
object
1 property
BulkExportDTODesktopLayoutBulkExportDTO
object
Bulk export Dto
5 properties
BulkResponseDTO
object
1 property
BulkRequestItemDTODesktopLayoutDTO
object
List of items in the bulk request.
3 properties
MetaDataReferencesPagingInfo
object
Metadata of response for references with paging information
8 properties
EntityInfo
object
6 properties
EntityReferenceInfoDTO
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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