> ## 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 Invite

> Returns detailed information about a specific assessment invite.



## OpenAPI

````yaml GET /invites/{inviteId}
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:
  /invites/{inviteId}:
    get:
      tags:
        - Invites
      summary: Get invite details
      description: Returns detailed information about a specific assessment invite.
      operationId: getInvite
      parameters:
        - $ref: '#/components/parameters/InviteId'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InviteDetail'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    InviteId:
      name: inviteId
      in: path
      description: Unique identifier of the invite
      required: true
      schema:
        type: string
        format: uuid
  schemas:
    InviteDetail:
      allOf:
        - $ref: '#/components/schemas/InviteSummary'
        - type: object
          properties:
            assignedGrader:
              type: object
              nullable: true
              description: Grader assigned to review this candidate's submission
              properties:
                id:
                  type: string
                  description: Unique identifier of the grader
                firstName:
                  type: string
                  nullable: true
                  description: First name of the grader
                lastName:
                  type: string
                  nullable: true
                  description: Last name of the grader
                email:
                  type: string
                  format: email
                  description: Email address of the grader
            proctoringSettings:
              type: object
              description: Proctoring configuration for this invite
              properties:
                screenRecording:
                  type: boolean
                  description: Whether screen recording is enabled
                webcamMonitoring:
                  type: boolean
                  description: Whether webcam monitoring is enabled
                requireIdCapture:
                  type: boolean
                  description: Whether ID capture is required before starting
            customMessage:
              type: string
              nullable: true
              description: Custom message included with the invite
            revokedAt:
              type: string
              format: date-time
              nullable: true
              description: When the invite was revoked (if applicable)
    InviteSummary:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier of the invite
        assessmentId:
          type: string
          format: uuid
          description: ID of the assessment
        assessmentName:
          type: string
          description: Name of the assessment
        recipientEmail:
          type: string
          format: email
          description: Email address of the invited candidate
        recipientName:
          type: string
          nullable: true
          description: Name of the invited candidate
        status:
          type: string
          enum:
            - pending
            - accepted
            - started
            - completed
            - expired
            - revoked
          description: Current status of the invite
        questionReplayLimit:
          type: integer
          description: Maximum number of times a candidate can replay each question
        answerRecordLimit:
          type: integer
          description: Maximum number of recording attempts per answer
        sentAt:
          type: string
          format: date-time
          description: When the invite was sent
        expiresAt:
          type: string
          format: date-time
          description: When the invite expires
        acceptedAt:
          type: string
          format: date-time
          nullable: true
          description: When the invite was accepted
        startedAt:
          type: string
          format: date-time
          nullable: true
          description: When the candidate started the assessment
        completedAt:
          type: string
          format: date-time
          nullable: true
          description: When the candidate completed the assessment
    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

````