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

# Get compliance run

> Retrieve a single compliance run with all its assigned checks.



## OpenAPI

````yaml /openapi.json get /api/public/v1/compliance/runs/{id}
openapi: 3.0.3
info:
  title: MSPortal Public API
  version: 1.0.0
  description: >-
    Public API for MSPortal - provides programmatic access to tenant data.


    ## Authentication


    All endpoints require authentication via API key passed as a Bearer token:


    ```

    Authorization: Bearer <your-api-key>

    ```


    API keys can be created in the MSPortal dashboard under Settings →
    Integrations → API Access.


    **Important:** Do not include cookies in API requests. The public API uses
    stateless authentication only.


    ## Scopes


    API keys are granted specific scopes that determine what operations they can
    perform. Each endpoint documents its required scope(s).


    ## Rate Limiting


    API calls are rate limited per API key. Rate limit information is returned
    in response headers:


    - `X-RateLimit-Limit`: Maximum requests per minute

    - `X-RateLimit-Remaining`: Remaining requests in current window

    - `X-RateLimit-Reset`: When the rate limit resets (ISO 8601)


    ## Request ID


    All responses include an `X-Request-Id` header for debugging and support.
    You can also pass your own `X-Request-Id` header to correlate requests.
  contact:
    name: MSPortal Support
    email: support@msportal.ai
  license:
    name: Proprietary
servers:
  - url: https://app.msportal.ai
    description: Production environment
security:
  - BearerAuth: []
tags:
  - name: Budgets
    description: >-
      Budget management - create, track, and forecast budgets with line items,
      categories, and products
  - name: Calendar
    description: Calendar and meeting management - events, participants, and meeting types
  - name: Companies
    description: Company management endpoints
  - name: Company Users
    description: Company user management - client portal contacts (read-only, paginated)
  - name: Compliance
    description: Compliance check management - runs, assigned checks, and status updates
  - name: Dashboards
    description: Dashboard management - external iframe resources and internal dashboards
  - name: Devices
    description: Device management - inventory, types, and locations
  - name: Goals
    description: Goal management - create, track, and manage goals with tasks and updates
  - name: NPS Surveys
    description: >-
      NPS survey management - Net Promoter Score surveys, responses, and
      analytics
  - name: Reports
    description: >-
      Report management - create, manage, and schedule reports with templates
      and types
  - name: Planner
    description: >-
      Planner item management - tasks, roadmap items, and project planning with
      linked goals, compliance, and projects
  - name: Surveys
    description: >-
      General survey management - multi-question surveys, responses, and
      statistics
  - name: Tickets
    description: Ticket management - view and filter tickets from PSA integrations
  - name: Training
    description: >-
      Training management - courses, enrollments, certificates, and progress
      tracking
  - name: Users
    description: Tenant user management - internal staff and team members (read-only)
  - name: Automation Rules
    description: >-
      Automation rule management - create, configure, and monitor automation
      rules with triggers, conditions, and actions
  - name: Analytics
    description: >-
      Analytics and reporting - company audit data, training analytics, user
      activity, and portfolio metrics
paths:
  /api/public/v1/compliance/runs/{id}:
    get:
      tags:
        - Compliance
      summary: Get compliance run
      description: Retrieve a single compliance run with all its assigned checks.
      parameters:
        - schema:
            type: string
            format: uuid
            description: Compliance run ID
          required: true
          description: Compliance run ID
          name: id
          in: path
      responses:
        '200':
          description: Compliance run with assigned checks
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComplianceRunDetailResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Compliance run not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    ComplianceRunDetailResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ComplianceRun'
        assignedChecks:
          type: array
          items:
            $ref: '#/components/schemas/ComplianceAssignedCheck'
          description: Assigned checks for this run
      required:
        - data
        - assignedChecks
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Error message
        requestId:
          type: string
          description: Request correlation ID
        details:
          nullable: true
          description: Additional error details
        code:
          type: string
          description: Error code
      required:
        - error
    ComplianceRun:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique compliance run identifier
        name:
          type: string
          description: Run name
        companyId:
          type: string
          format: uuid
          description: Company ID this run belongs to
        companyName:
          type: string
          nullable: true
          description: Company name
        runDate:
          type: string
          format: date-time
          description: Run date (ISO 8601)
        isCompleted:
          type: boolean
          description: Whether the run is completed
        notes:
          type: string
          nullable: true
          description: Run notes
        createdAt:
          type: string
          format: date-time
          description: Creation timestamp (ISO 8601)
        createdBy:
          type: string
          nullable: true
          description: User ID who created the run
        totalChecks:
          type: integer
          description: Total number of assigned checks
        passedChecks:
          type: integer
          description: Number of passed checks
        failedChecks:
          type: integer
          description: Number of failed checks
        pendingChecks:
          type: integer
          description: Number of pending checks
      required:
        - id
        - name
        - companyId
        - companyName
        - runDate
        - isCompleted
        - notes
        - createdAt
        - createdBy
        - totalChecks
        - passedChecks
        - failedChecks
        - pendingChecks
    ComplianceAssignedCheck:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique assigned check identifier
        checkId:
          type: string
          format: uuid
          description: Reference to the check definition
        title:
          type: string
          description: Check title
        description:
          type: string
          nullable: true
          description: Check description
        status:
          allOf:
            - $ref: '#/components/schemas/ComplianceStatus'
            - nullable: true
              description: Current status
        priority:
          type: string
          enum:
            - High
            - Medium
            - Low
          description: Priority level
        criticality:
          type: integer
          minimum: 1
          maximum: 10
          description: Criticality score (1-10)
        flagged:
          type: boolean
          description: Whether the check is flagged for attention
        dueDate:
          type: string
          nullable: true
          format: date-time
          description: Due date (ISO 8601)
        completedAt:
          type: string
          nullable: true
          format: date-time
          description: Completion date (ISO 8601)
        notesPublic:
          type: string
          nullable: true
          description: Public notes (visible to clients)
        notesPrivate:
          type: string
          nullable: true
          description: Private notes (internal only)
        runId:
          type: string
          format: uuid
          description: Compliance run ID
        runName:
          type: string
          nullable: true
          description: Run name
        companyId:
          type: string
          format: uuid
          description: Company ID
        companyName:
          type: string
          nullable: true
          description: Company name
        groupId:
          type: string
          nullable: true
          format: uuid
          description: Group ID if assigned to a group
        groupName:
          type: string
          nullable: true
          description: Group name
        deviceId:
          type: string
          nullable: true
          format: uuid
          description: Device ID if device-scoped
        deviceName:
          type: string
          nullable: true
          description: Device name
        locationId:
          type: string
          nullable: true
          format: uuid
          description: Location ID if location-scoped
        locationName:
          type: string
          nullable: true
          description: Location name
        updatedAt:
          type: string
          format: date-time
          description: Last update timestamp (ISO 8601)
      required:
        - id
        - checkId
        - title
        - description
        - status
        - priority
        - criticality
        - flagged
        - dueDate
        - completedAt
        - notesPublic
        - notesPrivate
        - runId
        - runName
        - companyId
        - companyName
        - groupId
        - groupName
        - deviceId
        - deviceName
        - locationId
        - locationName
        - updatedAt
    ComplianceStatus:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Status item ID
        name:
          type: string
          description: Status name (e.g., 'Pass', 'Fail', 'Pending')
        color:
          type: string
          description: Status color (hex code)
        isPositive:
          type: boolean
          description: Whether this is a positive/passing status
        isComplete:
          type: boolean
          description: Whether this status marks the check as complete
      required:
        - id
        - name
        - color
        - isPositive
        - isComplete
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Use your API key as a Bearer token. API keys can be generated in
        Settings → Integrations → API Access.

````