> ## 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. # List NPS responses > Retrieve paginated NPS responses with optional filters. ## OpenAPI ````yaml /openapi.json get /api/public/v1/surveys/nps/responses 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 ``` 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 environment 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 paths: /api/public/v1/surveys/nps/responses: get: tags: - NPS Surveys summary: List NPS responses description: Retrieve paginated NPS responses with optional filters. parameters: - schema: type: number minimum: 1 default: 1 description: Page number required: false description: Page number name: page in: query - schema: type: number minimum: 1 maximum: 100 default: 25 description: Items per page required: false description: Items per page name: limit in: query - schema: type: string enum: - response_date - score - respondent_name - created_at default: response_date description: Field to sort by required: false description: Field to sort by name: sortColumn in: query - schema: type: boolean nullable: true default: true description: Sort descending required: false description: Sort descending name: sortDesc in: query - schema: type: string format: uuid description: Filter by survey ID required: false description: Filter by survey ID name: surveyId in: query - schema: type: string format: uuid description: Filter by company ID required: false description: Filter by company ID name: companyId in: query - schema: type: string enum: - promoter - passive - detractor description: Filter by NPS category required: false description: Filter by NPS category name: category in: query - schema: type: boolean nullable: true description: Filter by follow-up required status required: false description: Filter by follow-up required status name: followUpRequired in: query - schema: type: string maxLength: 255 description: Search by respondent name, email, or feedback required: false description: Search by respondent name, email, or feedback name: search in: query - schema: type: string format: date-time description: Filter by response date (from) required: false description: Filter by response date (from) name: dateFrom in: query - schema: type: string format: date-time description: Filter by response date (to) required: false description: Filter by response date (to) name: dateTo in: query responses: '200': description: List of NPS responses content: application/json: schema: $ref: '#/components/schemas/NpsResponseListResponse' '400': description: Invalid query parameters content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] components: schemas: NpsResponseListResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/NpsResponse' pagination: $ref: '#/components/schemas/Pagination' required: - data - pagination 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 NpsResponse: type: object properties: id: type: string description: Response identifier surveyId: type: string description: Survey identifier score: type: number minimum: 0 maximum: 10 description: NPS score (0-10) category: type: string enum: - promoter - passive - detractor description: Category based on score feedbackText: type: string nullable: true description: Written feedback companyId: type: string nullable: true description: Company ID companyName: type: string nullable: true description: Company name respondentName: type: string nullable: true description: Respondent name respondentEmail: type: string nullable: true description: Respondent email responseDate: type: string format: date-time description: Response timestamp source: type: string description: Response source (email, web, api) followUpRequired: type: boolean description: Whether follow-up is required followUpCompleted: type: boolean description: Whether follow-up is completed tags: type: array items: type: string description: Tags for categorization required: - id - surveyId - score - category - feedbackText - companyId - companyName - respondentName - respondentEmail - responseDate - source - followUpRequired - followUpCompleted - tags 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. ````