openapi: 3.0.0
info:
  title: Webex Admin Address Book Report Templates 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: Report Templates
paths:
  /report/templates:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Template'
              example:
                items:
                - Id: 130
                  title: Client Version Prod
                  service: Teams
                  maxDays: 31
                  identifier: orgWithoutDate
                  validations:
                  - field: templateId
                    required: 'yes'
                numberOfTemplate: 1
        '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: List Report Templates
      operationId: List Report Templates
      description: 'List all the available report templates that can be generated.


        CSV (comma separated value) reports for Webex services are only supported for organizations based in the North American region. Organizations based in other regions will return blank CSV files for any Webex reports.


        #### Validation Fields


        Each template includes validation rules that specify which fields are required when generating a report using the [Reports API](/docs/api/v1/reports). The possible validation field values are:


        - **templateId**: The unique identifier of the report template to use. This is always required when creating a report.

        - **siteList**: A comma-separated list of Webex sites (e.g., "cisco.webex.com"). Required for site-based templates, typically for Webex Meetings reports.

        - **subIds**: Subscription IDs for the report. Required for certain enterprise agreement templates, particularly for Webex Onboarding service reports.

        - **startDate**: The start date for the report data range in YYYY-MM-DD format. Required for date-range based templates.

        - **endDate**: The end date for the report data range in YYYY-MM-DD format. Required for date-range based templates.


        When creating a report, ensure you provide all fields marked as "required": "yes" in the template''s validation rules.'
      tags:
      - Report Templates
      parameters: []
components:
  schemas:
    ValidationRulesCollection:
      type: object
      properties:
        validations:
          type: array
          items:
            $ref: '#/components/schemas/ValidationRules'
          description: An array of validation rules
    Template:
      type: object
      properties:
        id:
          type: string
          example: '130'
          description: Unique identifier representing a report.
        title:
          type: string
          example: Client Version
          description: Name of the template.
        service:
          type: string
          example: Teams
          description: The service to which the report belongs.
        maxDays:
          type: number
          example: 31
          description: Maximum date range for reports belonging to this template.
        identifier:
          type: string
          example: orgWithoutDate
          description: Generated reports belong to which field.
        validations:
          $ref: '#/components/schemas/ValidationRulesCollection'
    ValidationRules:
      type: object
      properties:
        field:
          type: string
          example: templateId
          description: Field on which validation rule is applied
        required:
          type: string
          example: 'yes'
          description: Whether the above field is required
  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