> ## 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 white space

> Standards white space. States: billed, open (white space: not deployed or billed), unbilled (deployed but not billed: leakage), declined. Without itemId: totals and per-standard counts, revenue, open and unbilled value and pricing, most opportunity first (25 per page). isLinked=false means no billing item proves the standard yet. With itemId: that standard's clients with state, users, estimated value, proving billing items and agreements (50 per page; filter by state). Staff only; requires the standards_white_space feature.



## OpenAPI

````yaml /openapi.json get /api/public/v1/standards/white-space
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/white-space:
    get:
      tags:
        - Standards
      summary: Get standards white space
      description: >-
        Standards white space. States: billed, open (white space: not deployed
        or billed), unbilled (deployed but not billed: leakage), declined.
        Without itemId: totals and per-standard counts, revenue, open and
        unbilled value and pricing, most opportunity first (25 per page).
        isLinked=false means no billing item proves the standard yet. With
        itemId: that standard's clients with state, users, estimated value,
        proving billing items and agreements (50 per page; filter by state).
        Staff only; requires the standards_white_space feature.
      parameters:
        - schema:
            type: string
            format: uuid
            description: Standard ID; returns that standard's per-client rows
          required: false
          description: Standard ID; returns that standard's per-client rows
          name: itemId
          in: query
        - schema:
            type: string
            enum:
              - open
              - unbilled
              - billed
              - declined
            description: With itemId, only clients in this state
          required: false
          description: With itemId, only clients in this state
          name: state
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 10000
            default: 1
          required: false
          name: page
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            description: Rows per page
          required: false
          description: Rows per page
          name: limit
          in: query
      responses:
        '200':
          description: White space
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/StandardsWhiteSpace'
                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'
        '404':
          description: Standard not found, or not applicable to any client
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    StandardsWhiteSpace:
      type: object
      properties:
        clientCount:
          type: integer
        totals:
          type: object
          properties:
            billedRevenue:
              type: number
              description: Amount in the tenant currency
            openValue:
              type: number
              description: Amount in the tenant currency
            unbilledValue:
              type: number
              description: Amount in the tenant currency
            openCells:
              type: integer
            unbilledCells:
              type: integer
            unlinkedStandards:
              type: integer
          required:
            - billedRevenue
            - openValue
            - unbilledValue
            - openCells
            - unbilledCells
            - unlinkedStandards
        standards:
          type: array
          items:
            $ref: '#/components/schemas/WhiteSpaceStandard'
        standard:
          $ref: '#/components/schemas/WhiteSpaceStandard'
        clients:
          type: array
          items:
            $ref: '#/components/schemas/WhiteSpaceClient'
        page:
          type: object
          properties:
            page:
              type: integer
            limit:
              type: integer
            totalCount:
              type: integer
            hasNextPage:
              type: boolean
          required:
            - page
            - limit
            - totalCount
            - hasNextPage
      required:
        - page
      description: >-
        Without itemId: clientCount, totals and standards. With itemId: standard
        and clients.
    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
    WhiteSpaceStandard:
      type: object
      properties:
        itemId:
          type: string
          format: uuid
        name:
          type: string
        categoryName:
          type: string
        isRequired:
          type: boolean
        isLinked:
          type: boolean
          description: False when no billing item proves the standard yet
        applicable:
          type: integer
        billed:
          type: integer
        open:
          type: integer
        unbilled:
          type: integer
        declined:
          type: integer
        billedRevenue:
          type: number
          description: Amount in the tenant currency
        openValue:
          type: number
          description: Amount in the tenant currency
        unbilledValue:
          type: number
          description: Amount in the tenant currency
        priceBasis:
          type: string
          enum:
            - per_user
            - median
            - default
            - none
        unitPrice:
          type: number
          nullable: true
          description: Amount in the tenant currency; null when unknown
      required:
        - itemId
        - name
        - categoryName
        - isRequired
        - isLinked
        - applicable
        - billed
        - open
        - unbilled
        - declined
        - billedRevenue
        - openValue
        - unbilledValue
        - priceBasis
        - unitPrice
    WhiteSpaceClient:
      type: object
      properties:
        companyId:
          type: string
          format: uuid
        companyName:
          type: string
        state:
          type: string
          enum:
            - open
            - unbilled
            - billed
            - declined
        users:
          type: integer
          nullable: true
        monthlyRevenue:
          type: number
          description: Amount in the tenant currency
        estimatedValue:
          type: number
          nullable: true
          description: Amount in the tenant currency; null when unknown
        provingSkus:
          type: array
          items:
            type: string
        agreements:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
              name:
                type: string
                nullable: true
            required:
              - id
              - name
      required:
        - companyId
        - companyName
        - state
        - users
        - monthlyRevenue
        - estimatedValue
        - provingSkus
        - agreements
  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.