Webex Partner Tags API

openapi: 3.2.0
info:
  title: Webex Admin Partner Tags 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.
  x-provenance:
    method: harvested
    authored_by: Cisco Webex
    harvested_by: API Evangelist
    harvested_on: '2026-08-19'
    first_party: true
    note: Published by Cisco. Retrieved unmodified except for this x-provenance block.
    provider_published: true
  x-evidence:
  - type: source
    url: https://github.com/webex/webex-openapi-specs/blob/main/public-spec/webex-admin.json
  - type: raw
    url: https://raw.githubusercontent.com/webex/webex-openapi-specs/main/public-spec/webex-admin.json
tags:
- name: Partner Tags
paths:
  /partner/tags:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TagsObj'
              example:
              - name: Tag name
                description: Tag description
        '400':
          description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.'
        '405':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.'
        '410':
          description: 'Gone: The requested resource is no longer available.'
        '415':
          description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.'
        '423':
          description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.'
        '428':
          description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
        '429':
          description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.'
        '500':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
      summary: Retrieve all customer tags
      operationId: RetrieveAllCustomerTags
      description: 'Retrieves all tags which are being used by any customer organizations. Once a tag is unassigned from the last customer, it is automatically removed and is not returned by this API.

        This API can be used by a partner full admin, a read-only partner, or an partner admin.

        The `type` can have the value ORGANIZATION or SUBSCRIPTION. If not provided, the value is ORGANIZATION'
      tags:
      - Partner Tags
      parameters:
      - name: type
        in: query
        description: List tags associated with an organization.
        required: true
        example: ORGANIZATION
        schema:
          type: string
      x-operation-id-source: normalized
      x-operation-id-original: Retrieve all customer tags
  /partner/tags/organizations/{orgId}/assignTags:
    post:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TagsObj'
              example:
              - name: Tag name
                description: Tag description
        '400':
          description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.'
        '405':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.'
        '410':
          description: 'Gone: The requested resource is no longer available.'
        '415':
          description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.'
        '423':
          description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.'
        '428':
          description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
        '429':
          description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.'
        '500':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
      summary: Create or Replace existing customer tags with the provided ones
      operationId: CreateOrReplaceExistingCustomerTagsWithTheProvidedOnes
      description: 'Assign or replace tag(s) which for a customer organization. If the tag doesn''t already exist, a new one is created and assigned to the customer automatically.

        This API can be used by partner full admins and partner admins.

        Each tag has a character limit of 25. Currently, there is a limit of 5 tags per organization when creating tags. To remove all the tags, pass an empty array.

        Specify the customer organization ID in the `orgId` parameter in the URI.'
      tags:
      - Partner Tags
      parameters:
      - name: orgId
        in: path
        description: The unique identifier for the customer organization.
        required: true
        example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jOTYwOTZiYi1kYTRhLTQ3NzEtYTc2Zi1kNDEzODQwZWVm1TQ
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TagsRequest'
      x-operation-id-source: normalized
      x-operation-id-original: Create or Replace existing customer tags with the provided ones
  /partner/tags/organizations/{orgId}:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerTagsResponse'
              example:
                orgName: Customer Name
                orgId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY
                tags:
                - Tags1
                - Tags2
        '400':
          description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.'
        '405':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.'
        '410':
          description: 'Gone: The requested resource is no longer available.'
        '415':
          description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.'
        '423':
          description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.'
        '428':
          description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
        '429':
          description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.'
        '500':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
      summary: Get customer organization's tags
      operationId: GetCustomerOrganization'sTags
      description: 'Retrieve tags associated with a customer organization based on the `orgId` provided.

        This API can be used by a partner full admin, a read-only partner, or an partner admin.

        Specify the customer orgId in the `orgId` parameter in the URI.'
      tags:
      - Partner Tags
      parameters:
      - name: orgId
        in: path
        description: Fetch all customers and associated tags for the customer.
        required: true
        example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jOTYwOTZiYi1kYTRhLTQ3NzEtYTc2Zi1kNDEzODQwZWVm1TQ
        schema:
          type: string
      x-operation-id-source: normalized
      x-operation-id-original: Get customer organization's tags
  /partner/tags/organizations:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomerTagsResponse'
              example:
              - orgName: Customer Name
                orgId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY
                tags:
                - Tags1
                - Tags2
        '400':
          description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.'
        '405':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.'
        '410':
          description: 'Gone: The requested resource is no longer available.'
        '415':
          description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.'
        '423':
          description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.'
        '428':
          description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
        '429':
          description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.'
        '500':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
      summary: Fetch all customers for a given set of tags
      operationId: FetchAllCustomersForAGivenSetOfTags
      description: 'For a set of tags, retrieve all customer organizations that match any one of the tags.

        This API can be used by a partner full admin, a read-only partner, or an partner admin.'
      tags:
      - Partner Tags
      parameters:
      - name: tags
        in: query
        description: A comma separated list of tags to filter by.
        required: true
        example: Tag1,Tag2
        schema:
          type: string
      - name: max
        in: query
        description: Value must be between 1 and 100, inclusive.
        example: '100'
        schema:
          type: number
      x-operation-id-source: normalized
      x-operation-id-original: Fetch all customers for a given set of tags
  /partner/tags/organizations/{orgId}/subscriptions/{subscriptionId}/assignTags:
    post:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TagsObj'
              example:
              - name: Tag name
                description: Tag description
        '400':
          description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.'
        '405':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.'
        '410':
          description: 'Gone: The requested resource is no longer available.'
        '415':
          description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.'
        '423':
          description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.'
        '428':
          description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
        '429':
          description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.'
        '500':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
      summary: Create or Replace existing subscription tags with the provided ones
      operationId: CreateOrReplaceExistingSubscriptionTagsWithTheProvidedOnes
      description: 'Assign or replace tags specific to each subscription for an organization. Each organization may have one or more subscriptions.

        This API can be used by partner full admins and partner admins.

        Currently there is a limit of 5 tags per subscription when creating tags. To remove all the tags, pass an empty array.

        Specify the customer organization ID in the `orgId` parameter in the URI and subscription ID in `subscriptionId` parameter'
      tags:
      - Partner Tags
      parameters:
      - name: orgId
        in: path
        description: The unique identifier for the customer organization.
        required: true
        example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jOTYwOTZiYi1kYTRhLTQ3NzEtYTc2Zi1kNDEzODQwZWVm1TQ
        schema:
          type: string
      - name: subscriptionId
        in: path
        description: The unique identifier for the subscription.
        required: true
        example: subscriptionId
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TagsRequest'
      x-operation-id-source: normalized
      x-operation-id-original: Create or Replace existing subscription tags with the provided ones
  /partner/tags/subscriptions:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SubscriptionTagsResponse'
              example:
              - orgName: Customer Name
                orgId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY
                tags:
                - Tags1,Tags2
                subscriptionId: Sub119911
                trial: 'false'
        '400':
          description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.'
        '405':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.'
        '410':
          description: 'Gone: The requested resource is no longer available.'
        '415':
          description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.'
        '423':
          description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.'
        '428':
          description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
        '429':
          description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.'
        '500':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
      summary: Subscription List on a given tag name or a set of tags
      operationId: SubscriptionListOnAGivenTagNameOrASetOfTags
      description: 'For a partner organization fetch all it''s subscriptions with their tag list for a given tag names.

        This API can be used by partner full admins, partner admins and admin read-only partners.'
      tags:
      - Partner Tags
      parameters:
      - name: tags
        in: query
        description: A comma separated list of tags to filter by.
        required: true
        example: Tag1,Tag2
        schema:
          type: string
      - name: max
        in: query
        description: Value must be between 1 and 100, inclusive.
        example: '100'
        schema:
          type: number
      x-operation-id-source: normalized
      x-operation-id-original: Subscription List on a given tag name or a set of tags
  /partner/tags/organizations/{orgId}/subscriptions/{subscriptionId}:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionTagsResponse'
              example:
                orgName: Customer Name
                orgId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY
                tags:
                - Tags1,Tags2
                subscriptionId: Sub119911
                trial: 'false'
        '400':
          description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.'
        '405':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.'
        '410':
          description: 'Gone: The requested resource is no longer available.'
        '415':
          description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.'
        '423':
          description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.'
        '428':
          description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
        '429':
          description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.'
        '500':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
      summary: Fetch a Subscription
      operationId: FetchASubscription
      description: 'For a given partner org, customer org and external subscription id, fetch subscription details with its associated tags.

        This API can be used by partner full admins, partner admins and admin read-only partners.'
      tags:
      - Partner Tags
      parameters:
      - name: orgId
        in: path
        description: The unique identifier for the customer organization.
        required: true
        example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jOTYwOTZiYi1kYTRhLTQ3NzEtYTc2Zi1kNDEzODQwZWVm1TQ
        schema:
          type: string
      - name: subscriptionId
        in: path
        description: The unique identifier for the subscription.
        required: true
        example: subscriptionId
        schema:
          type: string
      x-operation-id-source: normalized
      x-operation-id-original: Fetch a Subscription
components:
  schemas:
    SubscriptionTagsResponse:
      type: object
      properties:
        orgName:
          type: string
          example: Customer Name
          description: Name of the customer organization.
        orgId:
          type: string
          example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY
          description: The unique identifier for the customer organization.
        tags:
          type: array
          items:
            type: string
            example: Tags1,Tags2
          description: An array of tags.
        subscriptionId:
          type: string
          example: Sub119911
          description: The unique identifier for the subscription.
        trial:
          type: string
          example: 'false'
          description: boolean flag for trial or not.
    CustomerTagsResponse:
      type: object
      properties:
        orgName:
          type: string
          example: Customer Name
          description: Name of the customer organization.
        orgId:
          type: string
          example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY
          description: The unique identifier for the customer organization.
        tags:
          type: array
          items:
            type: string
            example: Tags1,Tags2
          description: An array of tags.
    TagsObj:
      type: object
      required:
      - name
      properties:
        name:
          type: string
          example: Tag name
          description: Name of the tag.
        description:
          type: string
          example: Tag description
          description: Description of the tag
    TagsRequest:
      type: object
      properties:
        tags:
          type: array
          items:
            $ref: '#/components/schemas/TagsObj'
          description: An array of tags.
  securitySchemes:
    oauth2:
      flows:
        authorizationCode:
          authorizationUrl: /
          scopes: {}
          tokenUrl: /
      type: oauth2
    bearer-key:
      type: http
      description: e.g. Bearer YOUR_AUTHORIZATION_TOKEN
      scheme: bearer
      bearerFormat: JWT
    bearerAuth:
      type: oauth2
      description: OAuth 2.0 Bearer token authentication
      flows:
        authorizationCode:
          authorizationUrl: https://webexapis.com/v1/authorize
          tokenUrl: https://webexapis.com/v1/access_token
          scopes:
            spark:applications_token: Create access tokens for Service Apps