openapi: 3.0.0
info:
  title: Webex Admin Address Book Meeting Polls 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: Meeting Polls
paths:
  /meetings/polls:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/PollCollectionResponse'
              example:
                items:
                - id: 1aea8390-e375-4547-b7ff-58ecd9e0b03d
                  meetingId: a2f95f5073e347489f7611492dbd6ad5_I_199075330905867928
                  startTime: '2021-07-06T09:22:34Z'
                  endTime: '2021-07-06T09:25:51Z'
                  timerDuration: 300
                  displayName: John Andersen
                  email: john.andersen@example.co
                  personId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xYTY5MmE2Mi00MTNmLTRjYWEtYjdkOS0wYzg0ZDZmMDdlNzY
                  questions:
                  - id: 6f31147e-dd69-4ea9-8b75-2c5834b72ba2
                    order: '1'
                    title: Where is Webex exclusively sold through local partners?
                    type: single
                    options:
                    - order: '1'
                      value: China
                      isCorrect: true
        '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 Meeting Polls
      operationId: List Meeting Polls
      description: 'Lists all the polls and the poll questions in a meeting when ready.


        * Only [meeting instances](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) in state `ended` or `inProgress` are supported for `meetingId`.


        * No pagination for this API because we don''t expect a large number of questions for each meeting.


        <div><Callout type="info">Polls are available within 15 minutes following the meeting.</Callout></div>'
      tags:
      - Meeting Polls
      parameters:
      - name: meetingId
        in: query
        description: A unique identifier for the [meeting instance](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) to which the polls belong.
        required: true
        example: 0ed74a1c0551494fb7a04e2881bf50ae_I_166022169160077044
        schema:
          type: string
  /meetings/pollResults:
    get:
      responses:
        '200':
          description: OK
          headers:
            Link:
              schema:
                type: string
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/PollResultCollectionResponse'
              example:
                items:
                - id: 1aea8390-e375-4547-b7ff-58ecd9e0b03d
                  meetingId: a2f95f5073e347489f7611492dbd6ad5_I_199075330905867928
                  totalAttendees: 10
                  totalRespondents: 10
                  startTime: '2021-07-06T09:25:34Z'
                  endTime: '2021-07-06T09:28:34Z'
                  timerDuration: 300
                  displayName: John Andersen
                  email: john.andersen@example.com
                  personId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xYTY5MmE2Mi00MTNmLTRjYWEtYjdkOS0wYzg0ZDZmMDdlNzY
                  questions:
                  - id: 6f31147e-dd69-4ea9-8b75-2c5834b72ba2
                    order: '1'
                    title: What colors do you like?
                    type: single
                    answerSummary:
                    - order: '1'
                      value: China
                      totalRespondents: 10
                      isCorrect: true
                    respondents:
                      links:
                        prev: https://webexapis.com/v1/meetings/polls/1d4959fe-682e-4107-a346-0e1feac7b899_M_7b789da198e531ce0c4d84243abd9fee_I_231245894851233679/questions/6f31147e-dd69-4ea9-8b75-2c5834b72ba2/respondents?meetingId=7b789da198e531ce0c4d84243abd9fee_I_231245894851233679&offset=0&max=5
                        self: https://webexapis.com/v1/meetings/polls/1d4959fe-682e-4107-a346-0e1feac7b899_M_7b789da198e531ce0c4d84243abd9fee_I_231245894851233679/questions/6f31147e-dd69-4ea9-8b75-2c5834b72ba2/respondents?meetingId=7b789da198e531ce0c4d84243abd9fee_I_231245894851233679&offset=5&max=5
                        next: https://webexapis.com/v1/meetings/polls/1d4959fe-682e-4107-a346-0e1feac7b899_M_7b789da198e531ce0c4d84243abd9fee_I_231245894851233679/questions/6f31147e-dd69-4ea9-8b75-2c5834b72ba2/respondents?meetingId=7b789da198e531ce0c4d84243abd9fee_I_231245894851233679&offset=10&max=5
                      items:
                      - displayName: John Andersen
                        email: john.andersen@example.com
                        answers:
                        - Green
        '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 Meeting PollResults
      operationId: Get Meeting PollResults
      description: 'List the meeting polls, the poll''s questions, and answers from the meeting when ready.


        * Only [meeting instances](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) in state `ended` or `inProgress` are supported for `meetingId`.


        * Long result sets will be split into [pages](/docs/basics#pagination).


        * This API is paginated by the sum of respondents from all questions in a meeting, these pagination links are returned in the response header.


        <div><Callout type="info">Polls results are available within 15 minutes following the meeting.</Callout></div>'
      tags:
      - Meeting Polls
      parameters:
      - name: meetingId
        in: query
        description: A unique identifier for the [meeting instance](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) to which the polls belong.
        required: true
        example: 0ed74a1c0551494fb7a04e2881bf50ae_I_166022169160077044
        schema:
          type: string
      - name: max
        in: query
        description: Limit the maximum number of respondents in a meeting in the response, up to 100.
        example: '10'
        schema:
          type: number
          default: 10
  /meetings/polls/{pollId}/questions/{questionId}/respondents:
    get:
      responses:
        '200':
          description: OK
          headers:
            Link:
              schema:
                type: string
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/RespondentCollectionResponse'
              example:
                items:
                - displayName: John Andersen
                  email: john.andersen@example.com
                  answers:
                  - Green
        '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 Respondents of a Question
      operationId: List Respondents of a Question
      description: 'Lists the respondents to a specific questions in a poll.


        * Only [meeting instances](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) in state `ended` or `inProgress` are supported for `meetingId`.


        * Long result sets are split into [pages](/docs/basics#pagination).


        <div><Callout type="info">The list of poll respondents are available within 15 minutes following the meeting.</Callout></div>'
      tags:
      - Meeting Polls
      parameters:
      - name: pollId
        in: path
        description: A unique identifier for the poll to which the respondents belong.
        required: true
        example: 1d4959fe-682e-4107-a346-0e1feac7b899_M_7b789da198e531ce0c4d84243abd9fee_I_231245894851233679
        schema:
          type: string
      - name: questionId
        in: path
        description: A unique identifier for the question to which the respondents belong.
        required: true
        example: 7c1eda33-cbef-4536-8e34-45b462347af8
        schema:
          type: string
      - name: meetingId
        in: query
        description: A unique identifier for the [meeting instance](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) to which the respondents belong.
        required: true
        example: 0ed74a1c0551494fb7a04e2881bf50ae_I_166022169160077044
        schema:
          type: string
      - name: max
        in: query
        description: Limit the maximum number of respondents in a specified question in the response, up to 100.
        example: '10'
        schema:
          type: number
          default: 10
components:
  schemas:
    Link:
      type: object
      properties:
        prev:
          type: string
          example: https://webexapis.com/v1/meetings/polls/1d4959fe-682e-4107-a346-0e1feac7b899_M_7b789da198e531ce0c4d84243abd9fee_I_231245894851233679/questions/6f31147e-dd69-4ea9-8b75-2c5834b72ba2/respondents?meetingId=7b789da198e531ce0c4d84243abd9fee_I_231245894851233679&offset=0&max=5
          description: Link to the previous question's respondents.
        self:
          type: string
          example: https://webexapis.com/v1/meetings/polls/1d4959fe-682e-4107-a346-0e1feac7b899_M_7b789da198e531ce0c4d84243abd9fee_I_231245894851233679/questions/6f31147e-dd69-4ea9-8b75-2c5834b72ba2/respondents?meetingId=7b789da198e531ce0c4d84243abd9fee_I_231245894851233679&offset=5&max=5
          description: Link to the current question's respondents.
        next:
          type: string
          example: https://webexapis.com/v1/meetings/polls/1d4959fe-682e-4107-a346-0e1feac7b899_M_7b789da198e531ce0c4d84243abd9fee_I_231245894851233679/questions/6f31147e-dd69-4ea9-8b75-2c5834b72ba2/respondents?meetingId=7b789da198e531ce0c4d84243abd9fee_I_231245894851233679&offset=10&max=5
          description: Link to the next page question's respondents.
    QuestionResult:
      type: object
      properties:
        id:
          type: string
          example: 6f31147e-dd69-4ea9-8b75-2c5834b72ba2
          description: A unique identifier of the question.
        order:
          type: string
          example: '1'
          description: The order of the question in the poll.
        title:
          type: string
          example: What colors do you like?
          description: The question.
        type:
          type: string
          enum:
          - single
          - multiple
          - short
          description: "The type of the question.\n * `single` - A single-answer question.\n * `multiple` - A multiple-answer question.\n * `short` - A text answer.\n"
        answerSummary:
          type: array
          items:
            $ref: '#/components/schemas/AnswerSummaryItem'
          description: Summary of all answers.
        respondents:
          $ref: '#/components/schemas/RespondentsReferenceLinks'
          description: Question's respondents.
    Question:
      type: object
      properties:
        id:
          type: string
          example: 6f31147e-dd69-4ea9-8b75-2c5834b72ba2
          description: A unique identifier for the question.
        order:
          type: string
          example: '1'
          description: The order of the question.
        title:
          type: string
          example: Where is Webex exclusively sold through local partners?
          description: The question.
        type:
          type: string
          enum:
          - single
          - multiple
          - short
          description: "The type of the question.\n * `single` - A single-answer question.\n * `multiple` - A multiple-answer question.\n * `short` - A text answer.\n"
        options:
          type: array
          items:
            $ref: '#/components/schemas/Option'
          description: Question's options.
    RespondentCollectionResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Respondent'
    PollResult:
      type: object
      properties:
        id:
          type: string
          example: 1aea8390-e375-4547-b7ff-58ecd9e0b03d
          description: A unique identifier for the poll.
        meetingId:
          type: string
          example: a2f95f5073e347489f7611492dbd6ad5_I_199075330905867928
          description: A unique identifier for the [meeting instance](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) to which the poll belongs.
        totalAttendees:
          type: number
          example: 10
          description: The total number of attendees in the meeting.
        totalRespondents:
          type: number
          example: 10
          description: The total number of respondents in the poll.
        startTime:
          type: string
          example: '2021-07-06T09:25:34Z'
          description: The date and time the poll started in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.
        endTime:
          type: string
          example: '2021-07-06T09:28:34Z'
          description: The date and time the poll ended in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.
        timerDuration:
          type: number
          example: 300
          description: The duration of the poll, in seconds.
        displayName:
          type: string
          example: John Andersen
          description: The name of the poll coordinator.
        email:
          type: string
          example: john.andersen@example.com
          description: The email of the poll coordinator.
        personId:
          type: string
          example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xYTY5MmE2Mi00MTNmLTRjYWEtYjdkOS0wYzg0ZDZmMDdlNzY
          description: The ID of the the poll coordinator.
        questions:
          type: array
          items:
            $ref: '#/components/schemas/QuestionResult'
          description: An array of questions in this poll.
    AnswerSummaryItem:
      type: object
      properties:
        order:
          type: string
          example: '1'
          description: The order of the answer in the question.
        value:
          type: string
          example: China
          description: The content of the answer.
        totalRespondents:
          type: number
          example: 10
          description: The total number of people who selected this answer.
        isCorrect:
          type: boolean
          example: true
          description: Whether the answer is correct.
    Poll:
      type: object
      properties:
        id:
          type: string
          example: 1aea8390-e375-4547-b7ff-58ecd9e0b03d
          description: A unique identifier for the poll.
        meetingId:
          type: string
          example: a2f95f5073e347489f7611492dbd6ad5_I_199075330905867928
          description: A unique identifier for the [meeting instance](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) to which the poll belongs.
        startTime:
          type: string
          example: '2021-07-06T09:22:34Z'
          description: The date and time the poll started in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.
        endTime:
          type: string
          example: '2021-07-06T09:25:51Z'
          description: The date and time the poll ended in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.
        timerDuration:
          type: number
          example: 300
          description: The length of time in the alarm box, in seconds.
        displayName:
          type: string
          example: John Andersen
          description: The name of the poll coordinator.
        email:
          type: string
          example: john.andersen@example.co
          description: The email of the poll coordinator.
        personId:
          type: string
          example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xYTY5MmE2Mi00MTNmLTRjYWEtYjdkOS0wYzg0ZDZmMDdlNzY
          description: The ID of the polling coordinator.
        questions:
          type: array
          items:
            $ref: '#/components/schemas/Question'
          description: Poll's questions.
    PollCollectionResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Poll'
    Option:
      type: object
      properties:
        order:
          type: string
          example: '1'
          description: The order of the option.
        value:
          type: string
          example: China
          description: The value of the option.
        isCorrect:
          type: boolean
          example: true
          description: Whether or not the option is correct.
    RespondentsReferenceLinks:
      type: object
      properties:
        links:
          $ref: '#/components/schemas/Link'
          description: The pagination links of this question's respondent.
        items:
          type: array
          items:
            $ref: '#/components/schemas/Respondent'
          description: An array of answers.
    PollResultCollectionResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/PollResult'
    Respondent:
      type: object
      properties:
        displayName:
          type: string
          example: John Andersen
          description: The name of the person who answers the question.
        email:
          type: string
          example: john.andersen@example.com
          description: The email of the person who answers the question.
        answers:
          type: array
          items:
            type: string
            example: Green
          description: An array of answers. Single answer or text questions contain only a single answer.
  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