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

# NPS API

> Read Net Promoter Score responses and manage NPS survey settings for your organization, with independent session scores and scoped API access.

NPS responses use a **0–10** scale. Configure delivery in [Settings → Surveys](https://docs.open.cx/resources/surveys.md) or through the settings API. Workflows provide Send Request, Generate Link, Get Score and Cancel Request actions.

All reads below require `nps:read` or `nps:write`; updating settings requires `nps:write`. Existing `csat:*` keys do not grant NPS access. Scores are scoped to the authenticated organization and survey type. A session can have separate CSAT, NPS and CES responses.

| Operation | Endpoint |
| - | - |
| [List scores](https://docs.open.cx/api-reference/nps/get_all.md) | `GET /nps/scores` |
| [Get a score](https://docs.open.cx/api-reference/nps/get.md) | `GET /nps/scores/{score_id}` |
| [Get a session’s score](https://docs.open.cx/api-reference/nps/get_session.md) | `GET /nps/scores/session/{session_id}` |
| [Check channel eligibility](https://docs.open.cx/api-reference/nps/check_channel.md) | `GET /nps/settings/channel/{channel}` |
| [Check whether sent](https://docs.open.cx/api-reference/nps/check_sent.md) | `GET /nps/sessions/{session_id}/sent` |
| [Read settings](https://docs.open.cx/api-reference/nps/get-settings.md) | `GET /nps/settings` |
| [Update settings](https://docs.open.cx/api-reference/nps/update-settings.md) | `PATCH /nps/settings` |

The sent-status response uses `nps_sent`. Score records include the latest rating and comment, session, contact, and agent/team attribution fixed at first submission. Score reads do not send a survey.

Settings updates are partial. Setting `auto_send_on_close` to `true` selects NPS and turns automatic sending off for the other types. Setting it to `false` only disables NPS. An omitted property stays unchanged. Template fields clear on null or an empty string; a null template uses the default design. Custom page controls retain the `data-csat-*` and `OpenCX.csat.submit` names.

MCP provides `list_nps_scores`, `get_nps_score`, `get_session_nps`, `get_nps_settings` and `update_nps_settings`. Its settings tool edits templates and the question; use the dashboard or REST settings API for other controls.


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