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

# Get Interview Shell

> Return the small campaign header/progress read model used by shell pages.



## OpenAPI

````yaml /openapi.json get /v1/interviews/{interview_id}/shell
openapi: 3.1.0
info:
  title: Ontora API
  description: >-
    Ontora's public API. Covers interview campaigns, transcripts, synthesis
    reports, graph queries, webhooks, and workspace management. 


    **Authentication**: endpoints accept either a Clerk JWT (`Authorization:
    Bearer <token>`) or a workspace API key (`X-API-Key: ont_...`). Workspace
    keys are managed via `/v1/api-keys`.
  version: 0.1.0
servers: []
security:
  - ClerkJWT: []
  - WorkspaceApiKey: []
tags:
  - name: interviews
    description: Campaign CRUD, lifecycle, contacts, question sets.
  - name: campaign-insights
    description: Synthesis outputs — cartography, roadmap, personas, conversations.
  - name: interview-query
    description: Graph RAG query over campaign data.
  - name: campaign-reports
    description: Versioned synthesis Reports — manual regenerate, version history.
  - name: interview-export
    description: Markdown / ZIP exports of transcripts and reports.
  - name: api-keys
    description: Manage workspace-scoped API keys for programmatic access.
  - name: webhook-endpoints
    description: Outbound webhook endpoints for automation.
  - name: booking
    description: Public self-scheduling endpoints for interview participants.
  - name: join
    description: Public QR-code / share-link self-registration for campaign participants.
  - name: workspaces
    description: Workspace and membership management.
  - name: vaults
    description: Context vault management.
paths:
  /v1/interviews/{interview_id}/shell:
    get:
      tags:
        - interviews
      summary: Get Interview Shell
      description: >-
        Return the small campaign header/progress read model used by shell
        pages.
      operationId: get_interview_shell_v1_interviews__interview_id__shell_get
      parameters:
        - name: interview_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Interview Id
        - name: X-API-Key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/app__api__interviews__CampaignShellOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    app__api__interviews__CampaignShellOut:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        name:
          type: string
          title: Name
        status:
          type: string
          title: Status
        workspace_id:
          type: string
          format: uuid
          title: Workspace Id
        is_shared:
          type: boolean
          title: Is Shared
          default: false
        anonymity_level:
          type: string
          title: Anonymity Level
          default: none
        invitations_scheduled_for:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Invitations Scheduled For
        timezone:
          anyOf:
            - type: string
            - type: 'null'
          title: Timezone
        progress:
          $ref: '#/components/schemas/CampaignShellProgressOut'
        report:
          $ref: '#/components/schemas/CampaignShellReportOut'
        graph:
          $ref: '#/components/schemas/CampaignShellGraphOut'
        join_link_delivery:
          type: boolean
          title: Join Link Delivery
          default: false
      type: object
      required:
        - id
        - name
        - status
        - workspace_id
        - progress
        - report
        - graph
      title: CampaignShellOut
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CampaignShellProgressOut:
      properties:
        total:
          type: integer
          title: Total
        pending:
          type: integer
          title: Pending
        scheduled:
          type: integer
          title: Scheduled
        in_progress:
          type: integer
          title: In Progress
        pending_review:
          type: integer
          title: Pending Review
        completed:
          type: integer
          title: Completed
        failed:
          type: integer
          title: Failed
        skipped:
          type: integer
          title: Skipped
        completion_percent:
          type: number
          title: Completion Percent
        target_threshold:
          type: integer
          title: Target Threshold
      type: object
      required:
        - total
        - pending
        - scheduled
        - in_progress
        - pending_review
        - completed
        - failed
        - skipped
        - completion_percent
        - target_threshold
      title: CampaignShellProgressOut
    CampaignShellReportOut:
      properties:
        id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Id
        status:
          anyOf:
            - type: string
            - type: 'null'
          title: Status
        version_number:
          anyOf:
            - type: integer
            - type: 'null'
          title: Version Number
        completed_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Completed At
      type: object
      title: CampaignShellReportOut
    CampaignShellGraphOut:
      properties:
        id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Id
        status:
          anyOf:
            - type: string
            - type: 'null'
          title: Status
        conversations_ingested:
          type: integer
          title: Conversations Ingested
          default: 0
        conversations_total:
          type: integer
          title: Conversations Total
          default: 0
        completed_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Completed At
      type: object
      title: CampaignShellGraphOut
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    ClerkJWT:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Clerk-issued RS256 JWT.
    WorkspaceApiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: 'Workspace-scoped API key (prefix: `ont_`).'
    HTTPBearer:
      type: http
      scheme: bearer

````