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

> Retrieve a single report by ID. Use includeStructure=true to include the full report content structure.



## OpenAPI

````yaml /openapi.json get /api/public/v1/reports/{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/reports/{id}:
    get:
      tags:
        - Reports
      summary: Get report
      description: >-
        Retrieve a single report by ID. Use includeStructure=true to include the
        full report content structure.
      parameters:
        - schema:
            type: string
            format: uuid
            description: Report ID
          required: true
          description: Report ID
          name: id
          in: path
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
            description: Include full report structure in response
          required: false
          description: Include full report structure in response
          name: includeStructure
          in: query
      responses:
        '200':
          description: Report details (with or without structure based on query param)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportWithStructureResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden - Missing required scope (reports.read)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Report not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    ReportWithStructureResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ReportWithStructure'
      required:
        - data
    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
    ReportWithStructure:
      allOf:
        - $ref: '#/components/schemas/Report'
        - type: object
          properties:
            reportStructure:
              allOf:
                - $ref: '#/components/schemas/ReportStructure'
                - nullable: true
                  description: Report content structure
          required:
            - reportStructure
    Report:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Report ID
        title:
          type: string
          description: Report title
        description:
          type: string
          nullable: true
          description: Report description
        status:
          allOf:
            - $ref: '#/components/schemas/ReportStatus'
            - description: Report status
        isShared:
          type: boolean
          description: Whether report is shared
        version:
          type: integer
          description: Report version number
        coverImageUrl:
          type: string
          nullable: true
          description: Cover image URL
        dateStart:
          type: string
          nullable: true
          description: Report date range start (ISO 8601)
        dateEnd:
          type: string
          nullable: true
          description: Report date range end (ISO 8601)
        companyId:
          type: string
          nullable: true
          format: uuid
          description: Associated company ID
        companyName:
          type: string
          nullable: true
          description: Associated company name
        reportTypeId:
          type: string
          nullable: true
          format: uuid
          description: Report type ID
        reportTypeName:
          type: string
          nullable: true
          description: Report type name
        reportTemplateId:
          type: string
          nullable: true
          format: uuid
          description: Template ID used to create report
        authorUserId:
          type: string
          nullable: true
          format: uuid
          description: Author user ID
        createdAt:
          type: string
          format: date-time
          description: Creation timestamp (ISO 8601)
        updatedAt:
          type: string
          format: date-time
          description: Last update timestamp (ISO 8601)
      required:
        - id
        - title
        - description
        - status
        - isShared
        - version
        - coverImageUrl
        - dateStart
        - dateEnd
        - companyId
        - companyName
        - reportTypeId
        - reportTypeName
        - reportTemplateId
        - authorUserId
        - createdAt
        - updatedAt
    ReportStructure:
      type: object
      properties:
        blocks:
          type: array
          items:
            $ref: '#/components/schemas/ReportBlock'
          description: Report content blocks
        metadata:
          allOf:
            - $ref: '#/components/schemas/ReportMetadata'
            - description: Report metadata settings
        pagePreset:
          type: string
          description: Page preset name
        displaySettings:
          allOf:
            - $ref: '#/components/schemas/ReportDisplaySettings'
            - description: Display and print settings
      required:
        - blocks
    ReportStatus:
      type: string
      enum:
        - draft
        - published
    ReportBlock:
      type: object
      properties:
        id:
          type: string
          description: Block ID
        type:
          type: string
          description: Block type (e.g., text, chart, table)
        params:
          type: object
          additionalProperties:
            nullable: true
        layout:
          $ref: '#/components/schemas/ReportBlockLayout'
      required:
        - id
        - type
    ReportMetadata:
      type: object
      properties:
        title:
          type: string
          description: Report metadata title
        subtitle:
          type: string
          description: Report metadata subtitle
        showHeader:
          type: boolean
          description: Whether to show header
        showFooter:
          type: boolean
          description: Whether to show footer
        showPageNumbers:
          type: boolean
          description: Whether to show page numbers
    ReportDisplaySettings:
      type: object
      properties:
        pageSize:
          type: string
          description: Page size (e.g., A4, Letter)
        orientation:
          type: string
          description: Page orientation (portrait, landscape)
        margins:
          type: object
          additionalProperties:
            type: number
    ReportBlockLayout:
      type: object
      properties:
        x:
          type: integer
          minimum: 0
          description: X position in grid
        'y':
          type: integer
          minimum: 0
          description: Y position in grid
        w:
          type: integer
          minimum: 1
          description: Width in grid units
        h:
          type: integer
          minimum: 1
          description: Height in grid units
      required:
        - x
        - 'y'
        - w
        - h
  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.

````