> ## Documentation Index
> Fetch the complete documentation index at: https://docs.neoagent.io/llms.txt
> Use this file to discover all available pages before exploring further.

# MSPortal API

> Read MSPortal Client Health, CSAT, NPS and Traffic Light so an agent can find the clients at risk of churn

The MSPortal API tool gives Neo agents access to MSPortal, the client success and vCIO portal. The common use is a monthly churn scan: the agent reads every client's Client Health score and risk level, how the score moved, CSAT, NPS detractors, the Traffic Light review and ticket trends, and ranks the clients at risk with the evidence. The [At-Risk Client Scan with MSPortal](https://docs.neoagent.io/integrations/msportal/overview.md#find-the-clients-at-risk-every-month) template sets that agent up.

> [!NOTE]
>
> Automatically enabled when you configure MSPortal permissions in your agent workflow.

## What It Does

* Read each client's Client Health score, risk level, previous score, dimension scores and the drivers that cost the most points, and its daily score history
* Read CSAT per client, NPS answers with their comments, and NPS per period
* Read the Traffic Light review list and a client's status, and log a review or set a status
* Read ticket trends, the portfolio summary, account readiness and benchmarks
* Read and update companies, meetings, budgets, goals, Planner items, reports, standards, compliance, projects, tasks and onboarding portals
* Read the devices, security findings, backups, Microsoft 365 data and invoices MSPortal syncs from your other tools

On a ticket, the agent reads and writes only the MSPortal company mapped to the ticket's company. A scheduled agent with no ticket, such as the churn scan, reads every client.

## Permission Groups

| Group | Access levels | Covers |
| - | - | - |
| Client Health, Surveys & Analytics | Disabled, Read Only, Read / Write | Client Health, CSAT, NPS and general surveys, the Traffic Light review, benchmarks, account readiness, analytics and dashboards |
| Companies & Contacts | Disabled, Read Only, Read / Write | Companies, their defaults and account notes, and their portal contacts. Deleting a company or adding a portal contact always asks a technician |
| Meetings, Budgets, Goals, Planner & Reports | Disabled, Read Only, Read / Write | Meetings and business reviews, budgets, goals, Planner items and reports |
| Standards & Compliance | Disabled, Read Only, Read / Write | Standards, tool stack cost, gap analysis, compliance runs, checks and risks |
| Tickets, Projects, Tasks & Onboarding | Disabled, Read Only, Read / Write | Tickets as MSPortal syncs them, projects, tasks and client onboarding portals |
| Devices, Security, Backup & Microsoft 365 | Disabled, Read Only, Read / Write | Devices, security findings, backup status, Microsoft 365 licences and Secure Score, and voice calls. MSPortal's API only reads these |
| Quotes, Invoices & Revenue | Disabled, Read Only, Read / Write | Quotes, invoices and revenue |
| Documentation, Training & Broadcasts | Disabled, Read Only, Read / Write | Documentation pages, training courses and enrollments, broadcasts and notifications |
| Users, Roles, Integrations & Settings | Disabled, Read Only, Read / Write | Staff users, roles, MSPortal's own integrations, automation rules and tenant settings. Creating or inviting a user, changing a user's status, any role change and any automation rule change always ask a technician |

## Setup

See [Connecting MSPortal to Neo](https://docs.neoagent.io/integrations/msportal/connecting-to-neo.md).


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