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

# Get Assessment

> Returns detailed information about a specific assessment.



## OpenAPI

````yaml GET /assessments/{assessmentId}
openapi: 3.0.3
info:
  title: AlfaOne Public API
  description: >
    Public API for third-party integrations with AlfaOne assessment platform.


    ## Authentication

    All endpoints require an API key passed in the `x-api-key` header.

    API keys can be generated from the Integrations page in your organization's
    admin dashboard.


    Each API key is scoped to a single organization, and all data returned will
    be filtered to that organization.
  version: 1.0.0
  contact:
    name: AlfaOne Support
servers:
  - url: https://alfaone.app/api/v1
    description: Production server
security:
  - ApiKeyAuth: []
tags:
  - name: Assessments
    description: Operations related to assessments
  - name: Questions
    description: Operations related to assessment questions
  - name: Members
    description: Operations related to organization members
  - name: Invites
    description: Operations related to assessment invites
  - name: Tags
    description: Operations related to organization tags
paths:
  /assessments/{assessmentId}:
    get:
      tags:
        - Assessments
      summary: Get assessment details
      description: Returns detailed information about a specific assessment.
      operationId: getAssessment
      parameters:
        - $ref: '#/components/parameters/AssessmentId'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssessmentDetail'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    AssessmentId:
      name: assessmentId
      in: path
      description: Unique identifier of the assessment
      required: true
      schema:
        type: string
        format: uuid
  schemas:
    AssessmentDetail:
      allOf:
        - $ref: '#/components/schemas/AssessmentSummary'
        - type: object
          properties:
            totalPoints:
              type: integer
              description: Total points available in the assessment
    AssessmentSummary:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier of the assessment
        name:
          type: string
          description: Name of the assessment
        defaultQuestionFormat:
          type: string
          enum:
            - text
            - audio
            - video
            - mixed
          description: Default format for questions
        defaultAnswerFormat:
          type: string
          enum:
            - text
            - audio
            - video
            - mixed
          description: Default format for answers
        languages:
          type: array
          items:
            type: string
          description: Languages used in the assessment
        questionCount:
          type: integer
          description: Number of questions in the assessment
        inviteCount:
          type: integer
          description: Number of invites sent for this assessment
        createdAt:
          type: string
          format: date-time
          description: When the assessment was created
        updatedAt:
          type: string
          format: date-time
          description: When the assessment was last updated
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Error message
  responses:
    Unauthorized:
      description: Authentication failed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            missing_key:
              summary: Missing API key
              value:
                error: API key is required
            invalid_key:
              summary: Invalid API key
              value:
                error: Invalid API key
            expired_key:
              summary: Expired API key
              value:
                error: API key has expired
            revoked_key:
              summary: Revoked API key
              value:
                error: API key has been revoked
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Assessment not found
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Internal server error
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key for authentication. Format:
        ak_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

````