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

> What fully expanding the MSP's existing offerings is worth: open white space plus deployed-but-unbilled standards, monthly and annual, and the clients with the most of it (top 20 by default, max 100). Partner products are excluded by default and never part of these totals; includePartnerProducts=true adds partnerProducts (uncovered capabilities only), partnerTotals and per-client partnerValue. Staff only; requires the standards_white_space feature.



## OpenAPI

````yaml /openapi.json get /api/public/v1/standards/opportunity
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/opportunity:
    get:
      tags:
        - Standards
      summary: Get standards opportunity
      description: >-
        What fully expanding the MSP's existing offerings is worth: open white
        space plus deployed-but-unbilled standards, monthly and annual, and the
        clients with the most of it (top 20 by default, max 100). Partner
        products are excluded by default and never part of these totals;
        includePartnerProducts=true adds partnerProducts (uncovered capabilities
        only), partnerTotals and per-client partnerValue. Staff only; requires
        the standards_white_space feature.
      parameters:
        - schema:
            type: boolean
            default: false
          required: false
          name: includePartnerProducts
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            description: Top clients to return (default 20)
          required: false
          description: Top clients to return (default 20)
          name: limit
          in: query
      responses:
        '200':
          description: Opportunity
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/StandardsOpportunity'
                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:
    StandardsOpportunity:
      type: object
      properties:
        clientCount:
          type: integer
        monthly:
          type: object
          properties:
            openValue:
              type: number
              description: Amount in the tenant currency
            unbilledValue:
              type: number
              description: Amount in the tenant currency
            total:
              type: number
              description: Amount in the tenant currency
          required:
            - openValue
            - unbilledValue
            - total
        annual:
          type: object
          properties:
            openValue:
              type: number
              description: Amount in the tenant currency
            unbilledValue:
              type: number
              description: Amount in the tenant currency
            total:
              type: number
              description: Amount in the tenant currency
          required:
            - openValue
            - unbilledValue
            - total
        openCells:
          type: integer
        unbilledCells:
          type: integer
        unlinkedStandards:
          type: integer
        clientsWithOpportunity:
          type: integer
        topClients:
          type: array
          items:
            $ref: '#/components/schemas/StandardsOpportunityClient'
        partnerProducts:
          type: array
          items:
            $ref: '#/components/schemas/StandardsCapabilityGap'
          description: Only with includePartnerProducts=true; uncovered capabilities only
        partnerTotals:
          type: object
          nullable: true
          properties:
            monthly:
              type: number
              description: Amount in the tenant currency
            annual:
              type: number
              description: Amount in the tenant currency
            monthlyWithPartners:
              type: number
              description: Amount in the tenant currency
            annualWithPartners:
              type: number
              description: Amount in the tenant currency
          required:
            - monthly
            - annual
            - monthlyWithPartners
            - annualWithPartners
      required:
        - clientCount
        - monthly
        - annual
        - openCells
        - unbilledCells
        - unlinkedStandards
        - clientsWithOpportunity
        - topClients
    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
    StandardsOpportunityClient:
      type: object
      properties:
        companyId:
          type: string
          format: uuid
        companyName:
          type: string
        users:
          type: integer
          nullable: true
        openStandards:
          type: integer
        billedStandards:
          type: integer
        unbilledStandards:
          type: integer
        openValue:
          type: number
          description: Amount in the tenant currency
        unbilledValue:
          type: number
          description: Amount in the tenant currency
        monthlyTotal:
          type: number
          description: Amount in the tenant currency
        partnerValue:
          type: number
          description: Only with includePartnerProducts=true
      required:
        - companyId
        - companyName
        - users
        - openStandards
        - billedStandards
        - unbilledStandards
        - openValue
        - unbilledValue
        - monthlyTotal
    StandardsCapabilityGap:
      type: object
      properties:
        capability:
          type: string
        partnerKey:
          type: string
          enum:
            - mizo
            - cyberhoot
        partnerName:
          type: string
        kind:
          type: string
          enum:
            - resale
            - internal
          description: 'resale: billed to clients; internal: runs the MSP''s own service desk'
        referralUrl:
          type: string
        defaultMonthlyPricePerUser:
          type: number
          nullable: true
        tenantMonthlyPricePerUser:
          type: number
          nullable: true
        monthlyPricePerUser:
          type: number
          nullable: true
        eligibleClients:
          type: integer
        clientsWithoutSeats:
          type: integer
        users:
          type: integer
        estimatedMonthlyValue:
          type: number
          nullable: true
          description: Amount in the tenant currency; null when unknown
        estimatedAnnualValue:
          type: number
          nullable: true
          description: Amount in the tenant currency; null when unknown
      required:
        - capability
        - partnerKey
        - partnerName
        - kind
        - referralUrl
        - defaultMonthlyPricePerUser
        - tenantMonthlyPricePerUser
        - monthlyPricePerUser
        - eligibleClients
        - clientsWithoutSeats
        - users
        - estimatedMonthlyValue
        - estimatedAnnualValue
  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.