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

# Get Assessment

> Retrieve dashboard-aligned assessment progress, including stage_progress, planned testing stages, current statuses, and start/completion timestamps when available. Use stage_progress rather than reconciling expected_testing_stages with stages.state yourself.



## OpenAPI

````yaml /openapi.json get /v1/assessments/{assessment_id}
openapi: 3.1.0
info:
  title: MindFort API
  version: 1.0.0
  description: >-
    The MindFort Public API supports targets, Discovery, assessments, finding
    lifecycle and analytics, and reports. Informational probe results are
    labeled `secured`.
servers:
  - url: https://api.mindfort.app
    description: Production
security:
  - bearerAuth: []
paths:
  /v1/assessments/{assessment_id}:
    get:
      tags:
        - Assessments
      summary: Get Assessment
      description: >-
        Retrieve dashboard-aligned assessment progress, including
        stage_progress, planned testing stages, current statuses, and
        start/completion timestamps when available. Use stage_progress rather
        than reconciling expected_testing_stages with stages.state yourself.
      operationId: getAssessment
      parameters:
        - name: assessment_id
          in: path
          required: true
          description: Assessment UUID
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicAssessmentDetail'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Not permitted for this organization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    PublicAssessmentDetail:
      type: object
      required:
        - id
        - target_id
        - target_name
        - assessment_type
        - assessment_method
        - status
        - created_at
        - updated_at
        - started_at
        - completed_at
        - expected_testing_stages
        - stages
        - stage_progress
      properties:
        id:
          type: string
          format: uuid
        target_id:
          type: string
          format: uuid
        target_name:
          type:
            - string
            - 'null'
        assessment_type:
          type: string
          enum:
            - black-box
            - white-box
        assessment_method:
          type:
            - string
            - 'null'
          enum:
            - balanced
            - deep
            - ultra
            - null
        status:
          type: string
          enum:
            - active
            - completed
            - failed
            - canceled
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        started_at:
          type:
            - string
            - 'null'
          format: date-time
        completed_at:
          type:
            - string
            - 'null'
          format: date-time
        failure_reason:
          type:
            - string
            - 'null'
          maxLength: 1000
          description: >-
            Customer-visible reason recorded for a failed assessment. Null for
            non-failed assessments or when no reason was recorded.
        expected_testing_stages:
          type: array
          description: >-
            Target-specific testing stages expected for this assessment. A stage
            without a matching entry in stages.state has not started yet.
          items:
            $ref: '#/components/schemas/PublicExpectedAssessmentStage'
        stages:
          description: >-
            Current assessment stages, including their statuses and individual
            test run times.
          anyOf:
            - $ref: '#/components/schemas/PublicAssessmentStages'
            - type: 'null'
        stage_progress:
          type: array
          description: >-
            Progress for planned and recorded assessment stages. Use this
            instead of reconciling expected_testing_stages with stages.state.
            NOT_STARTED means expected but not yet observed.
          items:
            $ref: '#/components/schemas/PublicAssessmentStageProgress'
      additionalProperties: false
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Human-readable error message
        code:
          type: string
          description: Stable machine-readable error code when one is available
        request_id:
          type: string
          description: Unique request identifier for debugging
    PublicExpectedAssessmentStage:
      type: object
      required:
        - id
        - name
      properties:
        id:
          type: string
          description: Planned testing-stage identifier.
        name:
          type: string
          description: Customer-visible expected stage name.
      additionalProperties: false
    PublicAssessmentStages:
      type: object
      required:
        - state
      properties:
        state:
          type: object
          description: Assessment stages indexed by stage identifier.
          additionalProperties:
            $ref: '#/components/schemas/PublicAssessmentStage'
      additionalProperties: false
    PublicAssessmentStageProgress:
      type: object
      required:
        - activity_type
        - assessment_stage
        - name
        - status
        - attempt
        - executors
      properties:
        activity_type:
          type: string
          enum:
            - RECON
            - TESTING
            - VALIDATION
            - AUTHENTICATION
        assessment_stage:
          type: string
          description: Assessment stage identifier.
        name:
          type: string
          description: Customer-visible stage name.
        status:
          type: string
          enum:
            - NOT_STARTED
            - RUNNING
            - ACTIVE
            - COMPLETED
            - SKIPPED
            - FAILED
            - TIMED_OUT
            - CANCELED
            - TERMINATED
            - CONTINUED_AS_NEW
        attempt:
          type:
            - integer
            - 'null'
          minimum: 1
        executors:
          type:
            - array
            - 'null'
          description: >-
            Individual test run statuses and start/completion times; null when
            no individual runs are reported for this stage.
          items:
            $ref: '#/components/schemas/PublicAssessmentExecutorStage'
      additionalProperties: false
    PublicAssessmentStage:
      type: object
      required:
        - activity_type
        - assessment_stage
        - name
        - status
        - attempt
        - executors
      properties:
        activity_type:
          type: string
          enum:
            - RECON
            - TESTING
            - VALIDATION
            - AUTHENTICATION
        assessment_stage:
          type: string
          description: Assessment stage identifier.
        name:
          type: string
          description: Customer-visible stage name.
        status:
          type: string
          enum:
            - RUNNING
            - ACTIVE
            - COMPLETED
            - SKIPPED
            - FAILED
            - TIMED_OUT
            - CANCELED
            - TERMINATED
            - CONTINUED_AS_NEW
        attempt:
          type: integer
          minimum: 1
        executors:
          type:
            - array
            - 'null'
          description: >-
            Individual test run statuses and start/completion times; null when
            no individual runs are reported for this stage.
          items:
            $ref: '#/components/schemas/PublicAssessmentExecutorStage'
      additionalProperties: false
    PublicAssessmentExecutorStage:
      type: object
      required:
        - status
      properties:
        name:
          type:
            - string
            - 'null'
          description: Name of the test run, when available.
        status:
          type: string
          enum:
            - starting
            - in_progress
            - done
            - failed
            - cancelled
        attempt:
          type:
            - integer
            - 'null'
        started_at:
          type:
            - string
            - 'null'
          format: date-time
          description: When this test run started, or null when not recorded.
        completed_at:
          type:
            - string
            - 'null'
          format: date-time
          description: When this test run finished, or null while active or unrecorded.
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key generated from the MindFort dashboard. Pass as `Authorization:
        Bearer <your-api-key>`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.