> ## 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 Traffic Light status

> A company's manual Traffic Light status (Green, Amber, Red), Purple specialist-handling flag, details, PSA sync state and paged history, plus the tenant's required fields and review prompts. A null record means Green. Staff only; requires the cs_traffic_light feature.



## OpenAPI

````yaml /openapi.json get /api/public/v1/customer-success/traffic-light/{companyId}
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/customer-success/traffic-light/{companyId}:
    get:
      tags:
        - Customer Success
      summary: Get Traffic Light status
      description: >-
        A company's manual Traffic Light status (Green, Amber, Red), Purple
        specialist-handling flag, details, PSA sync state and paged history,
        plus the tenant's required fields and review prompts. A null record
        means Green. Staff only; requires the cs_traffic_light feature.
      parameters:
        - schema:
            type: string
            format: uuid
            description: Company ID
          required: true
          description: Company ID
          name: companyId
          in: path
        - schema:
            type: integer
            minimum: 1
            default: 1
            description: History page
          required: false
          description: History page
          name: page
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
            description: History entries per page
          required: false
          description: History entries per page
          name: limit
          in: query
      responses:
        '200':
          description: Traffic Light status
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/TrafficLightStatus'
                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, permission, or the endpoint is staff-only
            or the cs_traffic_light feature is off
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Company not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    TrafficLightStatus:
      type: object
      properties:
        enabled:
          type: boolean
          description: False while the tenant has Traffic Light Review switched off
        requirements:
          type: object
          properties:
            amberRequiredFields:
              type: array
              items:
                type: string
            redRequiredFields:
              type: array
              items:
                type: string
            purpleRequiredFields:
              type: array
              items:
                type: string
            reviewPrompts:
              type: array
              items:
                type: string
          required:
            - amberRequiredFields
            - redRequiredFields
            - purpleRequiredFields
            - reviewPrompts
        record:
          type: object
          nullable: true
          properties:
            status:
              type: string
              enum:
                - green
                - amber
                - red
            reason:
              type: string
              nullable: true
            evidence:
              type: string
              nullable: true
            customerImpact:
              type: string
              nullable: true
            technicianGuidance:
              type: string
              nullable: true
            remediationPlan:
              type: string
              nullable: true
            targetOutcome:
              type: string
              nullable: true
            communicationStatus:
              type: string
              nullable: true
              enum:
                - not_required
                - planned
                - completed
                - null
            communicationPlan:
              type: string
              nullable: true
            exitCriteria:
              type: string
              nullable: true
            ownerUserId:
              type: string
              nullable: true
              format: uuid
            ownerName:
              type: string
              nullable: true
            approvedBy:
              type: string
              nullable: true
              format: uuid
            approvedByName:
              type: string
              nullable: true
            effectiveDate:
              type: string
              nullable: true
            nextReviewDate:
              type: string
              nullable: true
            statusSetAt:
              type: string
              nullable: true
            statusSetByName:
              type: string
              nullable: true
            purple:
              type: object
              properties:
                active:
                  type: boolean
                reason:
                  type: string
                  nullable: true
                technicianGuidance:
                  type: string
                  nullable: true
                exitCriteria:
                  type: string
                  nullable: true
                ownerUserId:
                  type: string
                  nullable: true
                  format: uuid
                ownerName:
                  type: string
                  nullable: true
                approvedBy:
                  type: string
                  nullable: true
                  format: uuid
                approvedByName:
                  type: string
                  nullable: true
                effectiveDate:
                  type: string
                  nullable: true
                nextReviewDate:
                  type: string
                  nullable: true
                setAt:
                  type: string
                  nullable: true
              required:
                - active
                - reason
                - technicianGuidance
                - exitCriteria
                - ownerUserId
                - ownerName
                - approvedBy
                - approvedByName
                - effectiveDate
                - nextReviewDate
                - setAt
            lastReviewedAt:
              type: string
              nullable: true
            lastReviewedByName:
              type: string
              nullable: true
            updatedAt:
              type: string
          required:
            - status
            - reason
            - evidence
            - customerImpact
            - technicianGuidance
            - remediationPlan
            - targetOutcome
            - communicationStatus
            - communicationPlan
            - exitCriteria
            - ownerUserId
            - ownerName
            - approvedBy
            - approvedByName
            - effectiveDate
            - nextReviewDate
            - statusSetAt
            - statusSetByName
            - purple
            - lastReviewedAt
            - lastReviewedByName
            - updatedAt
          description: Null when the company has never had a status set (Green)
        events:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
              eventType:
                type: string
                enum:
                  - status_changed
                  - status_updated
                  - purple_set
                  - purple_updated
                  - purple_cleared
                  - reviewed
              fromStatus:
                type: string
                nullable: true
                enum:
                  - green
                  - amber
                  - red
                  - null
              toStatus:
                type: string
                nullable: true
                enum:
                  - green
                  - amber
                  - red
                  - null
              note:
                type: string
                nullable: true
              actorName:
                type: string
                nullable: true
              approvedByName:
                type: string
                nullable: true
              reviewAnswers:
                type: array
                nullable: true
                items:
                  type: object
                  properties:
                    prompt:
                      type: string
                    answer:
                      type: string
                  required:
                    - prompt
                    - answer
              createdAt:
                type: string
            required:
              - id
              - eventType
              - fromStatus
              - toStatus
              - note
              - actorName
              - approvedByName
              - reviewAnswers
              - createdAt
        eventsPagination:
          $ref: '#/components/schemas/Pagination'
        psaSync:
          type: array
          items:
            type: object
            properties:
              provider:
                type: string
              syncedAt:
                type: string
                nullable: true
              syncError:
                type: string
                nullable: true
              attemptedAt:
                type: string
            required:
              - provider
              - syncedAt
              - syncError
              - attemptedAt
      required:
        - enabled
        - requirements
        - record
        - events
        - eventsPagination
        - psaSync
    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
    Pagination:
      type: object
      properties:
        page:
          type: integer
          minimum: 1
          description: Current page number
        limit:
          type: integer
          minimum: 1
          maximum: 100
          description: Items per page
        totalCount:
          type: integer
          description: Total number of items
        totalPages:
          type: integer
          description: Total number of pages
        hasNextPage:
          type: boolean
          description: Whether there is a next page
        hasPrevPage:
          type: boolean
          description: Whether there is a previous page
      required:
        - page
        - limit
        - totalCount
        - totalPages
        - hasNextPage
        - hasPrevPage
  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.