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

# List Assessments

> Lists assessments for your organization. Results use cursor pagination and do not include a total count.



## OpenAPI

````yaml /openapi.json get /v1/assessments
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:
    get:
      tags:
        - Assessments
      summary: List Assessments
      description: >-
        Lists assessments for your organization. Results use cursor pagination
        and do not include a total count.
      operationId: listAssessments
      parameters:
        - name: target_id
          in: query
          required: false
          description: Filter by target UUID
          schema:
            type: string
            format: uuid
        - name: assessment_type
          in: query
          required: false
          description: >-
            Filter by assessment type. `white-box` returns assessments that
            include code assessment; `black-box` returns assessments that do
            not.
          schema:
            type: string
            enum:
              - black-box
              - white-box
        - name: assessment_method
          in: query
          required: false
          description: Filter by assessment method
          schema:
            type: string
            enum:
              - balanced
              - deep
              - ultra
        - name: status
          in: query
          required: false
          description: Filter by assessment status
          schema:
            type: string
            enum:
              - active
              - completed
              - failed
              - canceled
        - name: order_by
          in: query
          required: false
          description: Sort field for cursor pagination
          schema:
            type: string
            enum:
              - created_at
              - updated_at
            default: created_at
        - name: order_direction
          in: query
          required: false
          description: Sort direction for cursor pagination
          schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
        - name: limit
          in: query
          required: false
          description: Maximum number of assessments to return
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
        - name: cursor
          in: query
          required: false
          description: >-
            Opaque URL-safe base64 cursor from `pagination.next_cursor`; it
            binds `order_by` and `order_direction` and carries the last
            `sort_at` and `id`.
          schema:
            type: string
      responses:
        '200':
          description: Assessments returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicAssessmentList'
        '400':
          description: Invalid filter, limit, or cursor
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized – missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    PublicAssessmentList:
      properties:
        assessments:
          items:
            $ref: '#/components/schemas/PublicAssessmentLifecycle'
          type: array
          title: Assessments
        pagination:
          $ref: '#/components/schemas/PublicAssessmentPagination'
      type: object
      required:
        - assessments
        - pagination
      title: PublicAssessmentList
      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
    PublicAssessmentLifecycle:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        target_id:
          type: string
          format: uuid
          title: Target Id
        target_name:
          title: Target Name
          type:
            - string
            - 'null'
        assessment_type:
          type: string
          enum:
            - black-box
            - white-box
          title: Assessment Type
        assessment_method:
          title: Assessment Method
          type:
            - string
            - 'null'
          enum:
            - balanced
            - deep
            - ultra
            - null
        status:
          type: string
          enum:
            - active
            - completed
            - failed
            - canceled
          title: Status
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
        started_at:
          title: Started At
          type:
            - string
            - 'null'
          format: date-time
        completed_at:
          title: Completed At
          type:
            - string
            - 'null'
          format: date-time
        failure_reason:
          title: 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.
      type: object
      required:
        - id
        - target_id
        - target_name
        - assessment_type
        - assessment_method
        - status
        - created_at
        - updated_at
        - started_at
        - completed_at
      title: PublicAssessmentLifecycle
      additionalProperties: false
    PublicAssessmentPagination:
      properties:
        limit:
          type: integer
          title: Limit
        has_more:
          type: boolean
          title: Has More
        next_cursor:
          type:
            - string
            - 'null'
          title: Next Cursor
      type: object
      required:
        - limit
        - has_more
        - next_cursor
      title: PublicAssessmentPagination
      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.