openapi: 3.0.0
info:
title: Webex Admin Address Book Entry Point API
version: 1.0.0
description: The Webex Admin APIs provide comprehensive programmatic access to administrative functions for managing Webex organizations, users, licenses, and settings. These APIs enable automation of user provisioning, license assignment, compliance management, and audit event retrieval. Administrators can integrate with enterprise identity systems, enforce security policies, monitor usage, and streamline onboarding/offboarding processes. The APIs support granular control over organizational resources, making them ideal for large-scale deployments and custom admin tooling.
tags:
- name: Entry Point
paths:
/organization/{orgid}/entry-point:
get:
tags:
- Entry Point
summary: List Entry Point(s)
description: "Retrieve a list of Entry Point(s) in a given organization.\n Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API."
operationId: getAllFilteredConfig
parameters:
- name: orgid
in: path
description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
required: true
schema:
type: string
example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
- name: filter
in: query
description: "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see <a href=\"https://www.here.com/docs/bundle/data-client-library-developer-guide-java-scala/page/client/rsql.html\">this reference</a>. For a list of supported operators, see <a href=\"https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference\">this syntax guide</a>.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n"
required: false
schema:
type: string
example: id=="2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
- name: channelTypes
in: query
description: ' [DEPRECATED] Channel type(s) allowed by the system.Separate values with commas.Use uppercase. By default, there is no channel type filtering.'
required: false
schema:
uniqueItems: true
type: array
items:
type: string
example: TELEPHONY,CHAT
- name: attributes
in: query
description: 'Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (ccOneQueue, userIds, queueRankings, links) '
required: false
schema:
type: string
format: string
example: id
- name: page
in: query
description: Defines the number of displayed page. The page number starts from 0.
schema:
type: integer
example: 0
default: 0
- name: pageSize
in: query
description: Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.
schema:
type: integer
example: 100
default: 100
- name: singleObjectResponse
in: query
description: Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.
schema:
type: boolean
example: false
default: false
responses:
'200':
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/EntryPointDTO'
'401':
description: Unauthorized Operation
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'403':
description: Operation is forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'404':
description: Resource not found or URI is invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'429':
description: Too many requests have been sent in a given amount of time and the request has been rate limited
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'500':
description: An Unexpected Error Occurred
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
deprecated: true
post:
tags:
- Entry Point
summary: Create a new Entry Point
description: Create a new Entry Point in a given organization.
operationId: createConfig_14
parameters:
- name: orgid
in: path
description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
required: true
schema:
type: string
example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EntryPointDTO'
required: true
responses:
'201':
description: Created
content:
'*/*':
schema:
$ref: '#/components/schemas/EntryPointDTO'
'400':
description: The request was invalid and cannot be served. An accompanying error message will explain further
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'401':
description: Unauthorized Operation
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'403':
description: Operation is forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'409':
description: Similar entity is already present
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'429':
description: Too many requests have been sent in a given amount of time and the request has been rate limited
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'500':
description: An Unexpected Error Occurred
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
deprecated: false
/organization/{orgid}/entry-point/bulk:
post:
tags:
- Entry Point
summary: Bulk save Entry Point(s)
description: Create, Update or delete Entry Point(s) in bulk in a given organization.
operationId: saveAllConfig_12
parameters:
- name: orgid
in: path
description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
required: true
schema:
type: string
example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BulkRequestDTOEntryPointDTO'
required: true
responses:
'207':
description: Multi-Status
content:
'*/*':
schema:
$ref: '#/components/schemas/BulkResponseDTO'
'400':
description: The request was invalid and cannot be served. An accompanying error message will explain further
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'401':
description: Unauthorized Operation
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'403':
description: Operation is forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'409':
description: Similar entity is already present
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'429':
description: Too many requests have been sent in a given amount of time and the request has been rate limited
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'500':
description: An Unexpected Error Occurred
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
deprecated: false
/organization/{orgid}/entry-point/bulk-export:
get:
tags:
- Entry Point
summary: Bulk export Entry Point(s)
description: Export all Entry Point(s) in a given organization.
operationId: bulkExport_12
parameters:
- name: orgid
in: path
description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
required: true
schema:
type: string
example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
- name: type
in: query
description: Indicates the type of Entrypoint; can be INBOUND or OUTBOUND.
required: true
schema:
type: string
enum:
- INBOUND
- OUTBOUND
example: INBOUND
- name: page
in: query
description: Defines the number of displayed page. The page number starts from 0.
schema:
type: integer
example: 0
default: 0
- name: pageSize
in: query
description: Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.
schema:
type: integer
example: 100
default: 50
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/BulkExportDTOEntryPointBulkExportDTO'
'401':
description: Unauthorized Operation
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'403':
description: Operation is forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'404':
description: Resource not found or URI is invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'429':
description: Too many requests have been sent in a given amount of time and the request has been rate limited
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'500':
description: An Unexpected Error Occurred
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
deprecated: true
/organization/{orgid}/entry-point/purge-inactive-entities:
post:
tags:
- Entry Point
summary: Purge inactive Entry Point(s)
description: Purge inactive Entry Point(s) older than the configured interval for a given organization.
operationId: purgeInactiveConfig_6
parameters:
- name: orgid
in: path
description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
required: true
schema:
type: string
example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
- name: nextStartId
in: query
description: This is the entity ID from which items for the next purge batch with be selected.
required: false
schema:
type: string
default: ''
example: af9eecc5-0472-4549-9a83-2afdae0d4ba0
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/Response'
'400':
description: The request was invalid and cannot be served. An accompanying error message will explain further
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'401':
description: Unauthorized Operation
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'403':
description: Operation is forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'409':
description: Similar entity is already present
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'429':
description: Too many requests have been sent in a given amount of time and the request has been rate limited
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'500':
description: An Unexpected Error Occurred
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
deprecated: false
/organization/{orgid}/entry-point/{id}:
get:
tags:
- Entry Point
summary: Get specific Entry Point by ID
description: Retrieve an existing Entry Point by ID in a given organization.
operationId: getConfig_15
parameters:
- name: orgid
in: path
description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
required: true
schema:
type: string
example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
- name: id
in: path
description: Resource ID of the Entry Point.
required: true
schema:
type: string
example: 2f9eecc5-0472-4549
- name: includeNames
in: query
description: Specifiy whether to include flow override settings reference variable names.
schema:
type: boolean
example: false
default: false
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/EntryPointDTO'
'401':
description: Unauthorized Operation
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'403':
description: Operation is forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'404':
description: Resource not found or URI is invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'429':
description: Too many requests have been sent in a given amount of time and the request has been rate limited
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'500':
description: An Unexpected Error Occurred
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
deprecated: false
put:
tags:
- Entry Point
summary: Update specific Entry Point by ID
description: Update an existing Entry Point by ID in a given organization.
operationId: updateConfig_15
parameters:
- name: orgid
in: path
description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
required: true
schema:
type: string
example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
- name: id
in: path
description: Resource ID of the Entry Point.
required: true
schema:
type: string
example: 2f9eecc5-0472-4549
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EntryPointDTO'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/EntryPointDTO'
'400':
description: The request was invalid and cannot be served. An accompanying error message will explain further
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'401':
description: Unauthorized Operation
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'403':
description: Operation is forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'404':
description: Resource not found or URI is invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'412':
description: Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'429':
description: Too many requests have been sent in a given amount of time and the request has been rate limited
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'500':
description: An Unexpected Error Occurred
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
deprecated: false
delete:
tags:
- Entry Point
summary: Delete specific Entry Point by ID
description: Delete an existing Entry Point by ID in a given organization.
operationId: deleteConfig_14
parameters:
- name: orgid
in: path
description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
required: true
schema:
type: string
example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
- name: id
in: path
description: Resource ID of the Entry Point.
required: true
schema:
type: string
example: 2f9eecc5-0472-4549
responses:
'204':
description: No Content
'401':
description: Unauthorized Operation
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'403':
description: Operation is forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'404':
description: Resource not found or URI is invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'412':
description: Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'429':
description: Too many requests have been sent in a given amount of time and the request has been rate limited
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'500':
description: An Unexpected Error Occurred
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
deprecated: false
/organization/{orgid}/entry-point/{id}/incoming-references:
get:
tags:
- Entry Point
summary: List references for a specific Entry Point
description: Retrieve a list of all entities that have reference to an existing Entry Point by ID in a given organization.
operationId: getIncomingReferences_11
parameters:
- name: orgid
in: path
description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
required: true
schema:
type: string
example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
- name: id
in: path
description: ID of this contact center resource.
required: true
schema:
type: string
example: af9eecc5-0472-4549-9a83-2afdae0d4ba0
- name: type
in: query
description: Entity type of the other entity that has a reference to this specific entity.
required: false
schema:
type: string
example: type_text
- name: page
in: query
description: Defines the number of displayed page. The page number starts from 0.
schema:
type: integer
example: 0
default: 0
- name: pageSize
in: query
description: Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.
schema:
type: integer
example: 100
default: 100
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/EntityReferenceInfoDTO'
'401':
description: Unauthorized Operation
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'403':
description: Operation is forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'404':
description: Resource not found or URI is invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'429':
description: Too many requests have been sent in a given amount of time and the request has been rate limited
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'500':
description: An Unexpected Error Occurred
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
deprecated: false
/organization/{orgid}/v2/entry-point:
get:
tags:
- Entry Point
summary: List Entry Point(s)
description: "Retrieve a list of Entry Point(s) in a given organization.\n Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API."
operationId: getAllFilteredConfigWithMetaData_1
parameters:
- name: orgid
in: path
description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
required: true
schema:
type: string
example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
- name: filter
in: query
description: "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see <a href=\"https://www.here.com/docs/bundle/data-client-library-developer-guide-java-scala/page/client/rsql.html\">this reference</a>. For a list of supported operators, see <a href=\"https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference\">this syntax guide</a>.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n"
required: false
schema:
type: string
example: id=="2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
- name: attributes
in: query
description: 'Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (ccOneQueue, userIds, queueRankings, links) '
required: false
schema:
type: string
format: string
example: id
- name: search
in: query
description: 'Filter data based on the search keyword.Supported search columns(name, description)
The examples below show some search queries
- "Cisco"
- field=="name";value=="Cisco"
- fields=in=("name","description");value=="Cisco"
'
required: false
schema:
type: string
example: contact center
- name: page
in: query
description: Defines the number of displayed page. The page number starts from 0.
schema:
type: integer
example: 0
default: 0
- name: pageSize
in: query
description: Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.
schema:
type: integer
example: 100
default: 100
- name: desktopProfileFilter
in: query
description: If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If set to false, the API will not check for Desktop Profile level access.
schema:
type: boolean
example: false
default: false
- name: provisioningView
in: query
description: 'If set to true, the API will only return data that user has access to, according to User Profile. If set to false and desktopProfileFilter query parameter is not specified, the API will add user associated data, based on desktop. '
schema:
type: boolean
example: false
default: false
- name: includeCount
in: query
description: Enable the flag to get the count of DN-EP Mapping
schema:
type: boolean
example: false
default: false
- name: singleObjectResponse
in: query
description: Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.
schema:
type: boolean
example: false
default: false
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ResponseEnvelopeEntryPointDTO'
'401':
description: Unauthorized Operation
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'403':
description: Operation is forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'404':
description: Resource not found or URI is invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'429':
description: Too many requests have been sent in a given amount of time and the request has been rate limited
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'500':
description: An Unexpected Error Occurred
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
deprecated: false
components:
schemas:
FlowOverrideSettingDTO:
required:
- name
- type
type: object
properties:
name:
type: string
type:
type: string
entityType:
type: string
entityId:
type: string
value:
type: string
Response:
type: object
properties:
code:
type: integer
format: int32
details:
type: object
additionalProperties:
type: object
links:
type: array
items:
$ref: '#/components/schemas/Link'
ApiErrorResponse:
description: Response body for an API error.
type: object
properties:
trackingId:
type: string
description: "An opaque identifier for mapping protocol failures to service internal codes. \n\nWhen specified in a request, it can be used for co-relating events across services"
example: c1a4fcef-aee2-4dea-8977-29f594760552
error:
description: An object containing details about the error.
$ref: '#/components/schemas/ErrorDetails'
Link:
type: object
properties:
href:
type: string
hreflang:
type: string
title:
type: string
type:
type: string
deprecation:
type: string
profile:
type: string
name:
type: string
templated:
type: boolean
ResponseEnvelopeEntryPointDTO:
type: object
properties:
meta:
type: object
additionalProperties:
type: ob
# --- truncated at 32 KB (48 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/webex/refs/heads/main/openapi/webex-entry-point-api-openapi.yml