Webex Skill Profile API

openapi: 3.0.0
info:
  title: Webex Admin Address Book Skill Profile 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: Skill Profile
paths:
  /organization/{orgid}/skill-profile:
    get:
      tags:
      - Skill Profile
      summary: List Skill Profile(s)
      description: "Retrieve a list of Skill Profile(s) in a given organization.\n Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead."
      operationId: getAllConfig_3
      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 spaces. If they do, please enclose them in quotes to apply the 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. By default, all attributes are returned along with the specified columns. All attributes are supported. except (activeSkills,activeEnumSkills)
        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
          default: 0
          example: 0
        example: 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
          default: 100
          example: 100
        example: 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
          default: false
          example: false
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SkillProfileDTOList'
              example:
              - organizationId: f53c8b54-46ca-43f6-ba05-08426a46e23d
                name: German Speaker
                description: Required for transferring out-dial calls to Queues
                createdTime: 123456789
                lastUpdatedTime: 123456789
                id: 93912f11-6017-404b-bf14-5331890b1797
                version: 1
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '404':
          description: Resource not found or URI is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '404'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '404'
                    entity: cc_user
                    references: []
        '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'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
      deprecated: false
    post:
      tags:
      - Skill Profile
      summary: Create a new Skill Profile
      description: Create a new Skill Profile in a given organization.
      operationId: createConfig_4
      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: skillProfileDTO
        in: query
        description: Skill profile configuration data
        required: true
        schema:
          $ref: '#/components/schemas/SkillProfileDTO'
        example:
          name: German Speaker
          description: Required for transferring out-dial calls to Queues
          activeSkills:
          - skillId: 123e4567-e89b-12d3-a456-426614174000
            proficiencyValue: 5
            booleanValue: true
      responses:
        '201':
          description: Created
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SkillProfileDTO'
        '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'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '400'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '400'
                    entity: cc_user
                    references: []
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '409':
          description: Similar entity is already present
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '409'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '409'
                    entity: cc_user
                    references: []
        '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'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
      deprecated: false
  /organization/{orgid}/skill-profile/bulk:
    post:
      tags:
      - Skill Profile
      summary: Bulk save Skill Profile(s)
      description: Create, Update or delete Skill Profile(s) in bulk in a given organization.
      operationId: saveAllConfig_3
      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/BulkRequestDTOSkillProfileDTO'
        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'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '400'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '400'
                    entity: cc_user
                    references: []
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '409':
          description: Similar entity is already present
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '409'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '409'
                    entity: cc_user
                    references: []
        '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'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
      deprecated: false
  /organization/{orgid}/skill-profile/{id}:
    get:
      tags:
      - Skill Profile
      summary: Get specific Skill Profile by ID
      description: Retrieve an existing Skill Profile by ID in a given organization.
      operationId: getConfig_4
      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 Skill Profile.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba2
      - name: includeSkillDetails
        in: query
        description: If set to true returns skill details
        schema:
          type: boolean
          default: false
          example: false
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SkillProfileDTO'
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '404':
          description: Resource not found or URI is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '404'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '404'
                    entity: cc_user
                    references: []
        '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'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
      deprecated: false
    put:
      tags:
      - Skill Profile
      summary: Update specific Skill Profile by ID
      description: Update an existing Skill Profile by ID in a given organization.
      operationId: updateConfig_4
      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 Skill Profile.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba2
      - name: skillProfileDTO
        in: query
        description: Skill profile configuration data for update
        required: true
        schema:
          $ref: '#/components/schemas/SkillProfileDTO'
        example:
          name: German Speaker Updated
          description: Updated skill profile for transferring calls
          activeSkills:
          - skillId: 123e4567-e89b-12d3-a456-426614174000
            proficiencyValue: 8
            booleanValue: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SkillProfileDTO'
        '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'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '400'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '400'
                    entity: cc_user
                    references: []
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '404':
          description: Resource not found or URI is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '404'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '404'
                    entity: cc_user
                    references: []
        '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'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '412'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '412'
                    entity: cc_user
                    references: []
        '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'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
      deprecated: false
    delete:
      tags:
      - Skill Profile
      summary: Delete specific Skill Profile by ID
      description: Delete an existing Skill Profile by ID in a given organization.
      operationId: deleteConfig_4
      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 Skill Profile.
        required: true
        schema:
          type: string
        example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba2
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '401'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '401'
                    entity: cc_user
                    references: []
        '403':
          description: Operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '403'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '403'
                    entity: cc_user
                    references: []
        '404':
          description: Resource not found or URI is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '404'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '404'
                    entity: cc_user
                    references: []
        '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'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '412'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '412'
                    entity: cc_user
                    references: []
        '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'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '429'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '429'
                    entity: cc_user
                    references: []
        '500':
          description: An Unexpected Error Occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
                error:
                  key: '500'
                  reason: Test reason
                  message:
                  - description: Test error
                    code: '500'
                    entity: cc_user
                    references: []
      deprecated: false
  /organization/{orgid}/skill-profile/{id}/incoming-references:
    get:
      tags:
      - Skill Profile
      summary: List references for a specific Skill Profile
      description: Retrieve a list of all entities that have reference to an existing Skill Profile by ID in a given organization.
      operationId: getIncomingReferences_3
      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
          default: 0
          example: 0
        example: 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
          default: 100
          example: 100
        example: 100
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EntityReferenceInfoDTO'
        '401':
          description: Unauthorized Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
          

# --- truncated at 32 KB (57 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/webex/refs/heads/main/openapi/webex-skill-profile-api-openapi.yml