> ## 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 standards evidence

> Evidence for building the MSP's standards: existing categories and standards (with linked billing items and AND-group flag), billed agreement SKUs / billing items by monthly revenue, top installed applications, PSA products, active integrations and device inventory with allowed planner types. Defaults: 40 SKUs (max 200), 30 apps (max 150), 30 products (max 120), up to 300 standards. Staff only; requires the standards_white_space feature and read_settings_tool_stack.



## OpenAPI

````yaml /openapi.json get /api/public/v1/standards/evidence
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 (US)
  - url: https://eu.msportal.ai
    description: Production (EU)
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
  - name: Client Onboarding
    description: >-
      Client onboarding - portals (phases, tasks, contacts, activation),
      templates, checklist templates, forms and documentation pages
  - name: Backup
    description: >-
      Backup - summaries, protected devices, alerts and SaaS protection (Datto,
      Axcient, Slide, Kaseya)
  - name: Microsoft 365
    description: Microsoft 365 - licenses, users, domains and Secure Score
  - name: Security
    description: >-
      Security - posture summary, EDR incidents, vulnerabilities, email threats,
      firewalls, DNS filtering and security awareness
  - name: Financial
    description: Financial - quotes, invoices and revenue summaries
  - name: Integrations
    description: Integrations - status, sync health, pause and resume (never credentials)
  - name: Documentation
    description: >-
      Documentation - pages, folders and articles synced from Hudu or IT Glue,
      plus built-in pages
  - name: Broadcasts
    description: Broadcasts - emergency broadcasts, recipients and groups
  - name: Notifications
    description: Notifications - the linked user's in-app notifications
  - name: Standards
    description: >-
      Standards - technology standards catalog, service plans, applicability,
      deployment statuses, compliance rollups, white space and costs
  - name: Customer Success
    description: >-
      Customer success - client health scores, trends, benchmarks and Traffic
      Light Reviews
  - name: Tasks
    description: Tasks - the linked user's personal task list
  - name: Tenant Setup
    description: Tenant setup - profile, branding and portal settings (never secrets)
  - name: Roles
    description: Roles - staff and client roles and their permission grants
  - name: Ticket Templates
    description: Ticket templates - reusable ticket definitions
  - name: Readiness
    description: Client readiness - account readiness assessments
  - name: Projects
    description: >-
      Projects - PSA projects with health overlays (deliverables, milestones,
      client actions, weekly updates), phases, tickets, time entries, PSA
      status/owner/priority write-through, ticket notes, task controls, display
      settings and the document library
paths:
  /api/public/v1/standards/evidence:
    get:
      tags:
        - Standards
      summary: Get standards evidence
      description: >-
        Evidence for building the MSP's standards: existing categories and
        standards (with linked billing items and AND-group flag), billed
        agreement SKUs / billing items by monthly revenue, top installed
        applications, PSA products, active integrations and device inventory
        with allowed planner types. Defaults: 40 SKUs (max 200), 30 apps (max
        150), 30 products (max 120), up to 300 standards. Staff only; requires
        the standards_white_space feature and read_settings_tool_stack.
      parameters:
        - schema:
            type: array
            items:
              type: string
              enum:
                - standards
                - billedSkus
                - software
                - psaProducts
                - integrations
                - inventory
            description: >-
              Sections to return (repeat the key or comma-separate); all when
              omitted
          required: false
          description: >-
            Sections to return (repeat the key or comma-separate); all when
            omitted
          name: include
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 200
            description: Billed SKUs to return, highest revenue first
          required: false
          description: Billed SKUs to return, highest revenue first
          name: skuLimit
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 150
            description: Applications to return, most clients first
          required: false
          description: Applications to return, most clients first
          name: softwareLimit
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 120
            description: PSA catalog products to return
          required: false
          description: PSA catalog products to return
          name: productLimit
          in: query
      responses:
        '200':
          description: Standards evidence
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/StandardsEvidence'
                required:
                  - data
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: >-
            Forbidden - missing scope, the linked user lacks the standards
            permission, or the linked user is a company user (staff only), or
            the standards_white_space feature is not enabled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    StandardsEvidence:
      type: object
      properties:
        categories:
          type: array
          nullable: true
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
              name:
                type: string
              plannerItemTypeId:
                type: string
                nullable: true
                format: uuid
              standards:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      format: uuid
                    name:
                      type: string
                    vendor:
                      type: string
                      nullable: true
                    isRequired:
                      type: boolean
                    linkedSkuLabels:
                      type: array
                      items:
                        type: string
                    linkedSkuCount:
                      type: integer
                    hasAndGroups:
                      type: boolean
                      description: >-
                        AND-group links are edited by hand; the skus endpoint
                        skips these
                  required:
                    - id
                    - name
                    - vendor
                    - isRequired
                    - linkedSkuLabels
                    - linkedSkuCount
                    - hasAndGroups
            required:
              - id
              - name
              - plannerItemTypeId
              - standards
        billedSkus:
          type: array
          nullable: true
          items:
            allOf:
              - $ref: '#/components/schemas/StandardSkuRef'
              - type: object
                properties:
                  label:
                    type: string
                  companyCount:
                    type: integer
                  monthlyRevenue:
                    type: number
                    description: Amount in the tenant currency
                  provesStandards:
                    type: array
                    items:
                      type: string
                required:
                  - label
                  - companyCount
                  - monthlyRevenue
                  - provesStandards
        software:
          type: array
          nullable: true
          items:
            type: object
            properties:
              name:
                type: string
              publisher:
                type: string
                nullable: true
              companyCount:
                type: integer
            required:
              - name
              - publisher
              - companyCount
        psaProducts:
          type: array
          nullable: true
          items:
            type: object
            properties:
              name:
                type: string
              sku:
                type: string
                nullable: true
            required:
              - name
              - sku
        activeIntegrations:
          type: array
          nullable: true
          items:
            type: string
        inventory:
          type: object
          nullable: true
          properties:
            devices:
              type: array
              items:
                type: object
                properties:
                  deviceType:
                    type: string
                  manufacturer:
                    type: string
                    nullable: true
                  companyCount:
                    type: integer
                  totalCompanies:
                    type: integer
                  deviceCount:
                    type: integer
                required:
                  - deviceType
                  - manufacturer
                  - companyCount
                  - totalCompanies
                  - deviceCount
            plannerTypes:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                  name:
                    type: string
                  description:
                    type: string
                    nullable: true
                required:
                  - id
                  - name
                  - description
          required:
            - devices
            - plannerTypes
        counts:
          type: object
          properties:
            standards:
              type: integer
              nullable: true
            billedSkus:
              type: integer
              nullable: true
            software:
              type: integer
              nullable: true
            psaProducts:
              type: integer
              nullable: true
          required:
            - standards
            - billedSkus
            - software
            - psaProducts
      required:
        - categories
        - billedSkus
        - software
        - psaProducts
        - activeIntegrations
        - inventory
        - counts
      description: Sections not requested are null; counts give full totals.
    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
    StandardSkuRef:
      type: object
      properties:
        provider:
          type: string
          enum:
            - connectwise
            - autotask
            - halo
          description: PSA of the billing item
        matchType:
          type: string
          enum:
            - service
            - contract_type
          description: >-
            service = a billed product/service line; contract_type = the
            agreement type it was billed under
        matchKey:
          type: string
          minLength: 1
          maxLength: 200
          description: >-
            The billing item's matchKey, exactly as the evidence endpoint
            returns it
      required:
        - provider
        - matchType
        - matchKey
  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.

````

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