Skilljar Question Banks > Questions API

openapi: 3.2.0
info:
  title: Skilljar Question Banks > Questions API
  version: 1.0.0
  description: The Skilljar API provides comprehensive access to our customer education platform, enabling you to programmatically manage courses, users, enrollments, and more.
tags:
- name: Question Banks > Questions
paths:
  /v1/question-banks/{question_bank_id}/questions:
    get:
      operationId: question_banks_questions_list
      description: 'List all Questions for the specified Question Bank.


        Returns a paginated list of Questions associated with the Question Bank.'
      parameters:
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: path
        name: question_bank_id
        schema:
          type: string
          pattern: ^[-:\.0-9a-z]+$
        required: true
      tags:
      - Question Banks > Questions
      security:
      - OrganizationApiKey: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedQuestionSummaryList'
          description: ''
      summary: Question banks questions list
      x-summary-source: derived
  /v1/question-banks/{question_bank_id}/questions/{question_id}:
    get:
      operationId: question_banks_questions_retrieve
      description: 'Retrieve details for a specific Question.


        Returns all metadata for the Question, including Answers.'
      parameters:
      - in: path
        name: question_bank_id
        schema:
          type: string
          pattern: ^[-:\.0-9a-z]+$
        required: true
      - in: path
        name: question_id
        schema:
          type: string
          pattern: ^[0-9a-z]+$
        required: true
      tags:
      - Question Banks > Questions
      security:
      - OrganizationApiKey: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuestionSummary'
          description: ''
      summary: Question banks questions retrieve
      x-summary-source: derived
    delete:
      operationId: question_banks_questions_destroy
      description: 'Delete a specific Question from the Question Bank.


        This will remove the Question and all associated Answers.'
      parameters:
      - in: path
        name: question_bank_id
        schema:
          type: string
          pattern: ^[-:\.0-9a-z]+$
        required: true
      - in: path
        name: question_id
        schema:
          type: string
          pattern: ^[0-9a-z]+$
        required: true
      tags:
      - Question Banks > Questions
      security:
      - OrganizationApiKey: []
      - tokenAuth: []
      responses:
        '204':
          description: No response body
      summary: Question banks questions destroy
      x-summary-source: derived
components:
  schemas:
    QuestionSummary:
      type: object
      description: Serializer for Question model within a Question Bank or Quiz.
      properties:
        id:
          type: string
          readOnly: true
        html:
          type: string
          description: The HTML content of the question.
        case_sensitive:
          type: boolean
          readOnly: true
          description: If true, student responses must match the case of the answer to be correct. This only impacts FILL_IN_THE_BLANK questions.
        requires_manual_grading:
          type: boolean
          readOnly: true
          description: If true for any question on the quiz, student responses for the corresponding quiz must be manually graded by a dashboard user.
        correct_answer_feedback_html:
          type: string
          readOnly: true
          description: The feedback to display if the student answers the question correctly.
        incorrect_answer_feedback_html:
          type: string
          readOnly: true
          description: The feedback to display if the student answers the question incorrectly.
        answer_feedback_html:
          type: string
          readOnly: true
          description: The feedback to display for nongraded questions.
        is_graded:
          type: boolean
          readOnly: true
          description: The question counts toward passing or failing.
        is_optional:
          type: boolean
          readOnly: true
        type:
          allOf:
          - $ref: '#/components/schemas/Type5d1Enum'
          description: 'The type of question to create. Can be: MULTIPLE_CHOICE, MULTIPLE_ANSWER, FILL_IN_THE_BLANK, FREEFORM.


            * `MULTIPLE_CHOICE` - MULTIPLE_CHOICE

            * `MULTIPLE_ANSWER` - MULTIPLE_ANSWER

            * `FILL_IN_THE_BLANK` - FILL_IN_THE_BLANK

            * `FREEFORM` - FREEFORM'
        order:
          type: integer
          readOnly: true
        answers:
          type: array
          items:
            $ref: '#/components/schemas/Answer'
          default: []
          description: "The answers for the question. This is required for MULTIPLE_CHOICE, MULTIPLE_ANSWER, and FILL_IN_THE_BLANK question types.<br><br>Example:<pre><code>[\n\t{\"answer_text\": \"Correct answer\", \"correct\": true},\n\t{\"answer_text\": \"Incorrect answer\", \"correct\": false},\n\t{\"answer_text\": \"Second incorrect answer\", \"correct\": false}\n]</pre></code>"
      required:
      - html
      - type
    Type5d1Enum:
      enum:
      - MULTIPLE_CHOICE
      - MULTIPLE_ANSWER
      - FILL_IN_THE_BLANK
      - FREEFORM
      type: string
      description: '* `MULTIPLE_CHOICE` - MULTIPLE_CHOICE

        * `MULTIPLE_ANSWER` - MULTIPLE_ANSWER

        * `FILL_IN_THE_BLANK` - FILL_IN_THE_BLANK

        * `FREEFORM` - FREEFORM'
    Answer:
      type: object
      properties:
        id:
          type: string
          readOnly: true
        answer_text:
          type: string
          maxLength: 1000
        correct:
          type: boolean
        order:
          type: integer
          readOnly: true
      required:
      - answer_text
    PaginatedQuestionSummaryList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/QuestionSummary'
  securitySchemes:
    OrganizationApiKey:
      type: http
      scheme: basic
      description: API key authentication using HTTP Basic Auth. Use your API key as the username and leave password empty.
    tokenAuth:
      type: http
      scheme: bearer