> ## Documentation Index
> Fetch the complete documentation index at: https://docs.staging.questra.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get questionnaire clarifications session for a revision

> Read-only history for a questionnaire revision. Does not start or advance a probe.



## OpenAPI

````yaml /openapi/program.openapi.json get /surveys/{surveyId}/questionnaire/revisions/{revision}/clarifications
openapi: 3.1.0
info:
  title: Questra Program API
  version: 0.0.1
  description: >-
    REST API for the Questra Program product. Browser users authenticate through
    Questra Auth SSO; automation uses workspace-scoped API keys (`Authorization:
    Bearer qpk_live_…`). API keys carry scopes enforced before handlers.
    Outbound webhooks follow Standard Webhooks (at-least-once delivery;
    consumers must be idempotent).
servers:
  - url: /v1
    description: Program API base path
security: []
paths:
  /surveys/{surveyId}/questionnaire/revisions/{revision}/clarifications:
    get:
      tags:
        - Survey questionnaire clarifications
      summary: Get questionnaire clarifications session for a revision
      description: >-
        Read-only history for a questionnaire revision. Does not start or
        advance a probe.
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: surveyId
          in: path
        - schema:
            type: integer
            exclusiveMinimum: 0
          required: true
          name: revision
          in: path
      responses:
        '200':
          description: Clarifications session
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuestionnaireClarificationsResponse'
        '404':
          description: Survey, revision, or Clarifications session not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
components:
  schemas:
    QuestionnaireClarificationsResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/QuestionnaireClarifications'
      required:
        - data
    ErrorBody:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
        resource:
          type: string
        slug:
          type: string
        file_id:
          type: string
        endpoint_id:
          type: string
        event_id:
          type: string
        delivery_id:
          type: string
        api_key_id:
          type: string
        integration_id:
          type: string
        audit_id:
          type: string
        status:
          type: string
        details: {}
        question_ids:
          type: array
          items:
            type: string
        survey_ids:
          type: array
          items:
            type: string
        revisions:
          type: array
          items:
            type: number
      required:
        - error
    QuestionnaireClarifications:
      type: object
      properties:
        survey_id:
          type: string
          format: uuid
        questionnaire_revision:
          type: integer
          exclusiveMinimum: 0
        status:
          $ref: '#/components/schemas/QuestionnaireClarificationsStatus'
        probe_exhausted:
          type: boolean
        active_workflow_id:
          type:
            - string
            - 'null'
          minLength: 1
          description: >-
            In-flight survey.questionnaire_clarifications workflow id
            (`wrun_...`) while probing; null otherwise.
        clarifications:
          type: array
          items:
            $ref: '#/components/schemas/QuestionnaireClarification'
        summary:
          type:
            - string
            - 'null'
        error:
          $ref: '#/components/schemas/QuestionnaireClarificationsError'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        completed_at:
          type:
            - string
            - 'null'
          format: date-time
      required:
        - survey_id
        - questionnaire_revision
        - status
        - probe_exhausted
        - active_workflow_id
        - clarifications
        - summary
        - error
        - created_at
        - updated_at
        - completed_at
    QuestionnaireClarificationsStatus:
      type: string
      enum:
        - probing
        - active
        - complete
        - failed
    QuestionnaireClarification:
      type: object
      properties:
        id:
          type: string
          format: uuid
        category:
          $ref: '#/components/schemas/QuestionnaireClarificationCategory'
        prompt:
          type: string
        context:
          type:
            - string
            - 'null'
        options:
          type: array
          items:
            $ref: '#/components/schemas/QuestionnaireClarificationOption'
        response:
          $ref: '#/components/schemas/QuestionnaireClarificationResponse'
        responded_at:
          type:
            - string
            - 'null'
          format: date-time
        created_at:
          type: string
          format: date-time
        resume_path:
          type:
            - string
            - 'null'
          minLength: 1
          description: >-
            Greenfield hook resume path for this clarification while the probe
            awaits a response.
      required:
        - id
        - category
        - prompt
        - context
        - options
        - response
        - responded_at
        - created_at
    QuestionnaireClarificationsError:
      type:
        - object
        - 'null'
      properties:
        code:
          type: string
        message:
          type: string
      required:
        - code
        - message
    QuestionnaireClarificationCategory:
      type: string
      enum:
        - ambiguity
        - instruction_collision
        - missing_reference
        - inconsistency
        - other
    QuestionnaireClarificationOption:
      type: object
      properties:
        id:
          type: string
          minLength: 1
        label:
          type: string
          minLength: 1
      required:
        - id
        - label
    QuestionnaireClarificationResponse:
      oneOf:
        - type: object
          properties:
            kind:
              type: string
              enum:
                - answer
            text:
              type: string
              minLength: 1
            option_id:
              type:
                - string
                - 'null'
              minLength: 1
          required:
            - kind
            - text
            - option_id
        - type: object
          properties:
            kind:
              type: string
              enum:
                - skip
          required:
            - kind
        - type: 'null'

````