> ## 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 general survey > Retrieve a single general survey with all its questions. ## OpenAPI ````yaml /openapi.json get /api/public/v1/surveys/{id} 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/{id}: get: tags: - Surveys summary: Get general survey description: Retrieve a single general survey with all its questions. parameters: - schema: type: string format: uuid description: Survey ID required: true description: Survey ID name: id in: path responses: '200': description: Survey details with questions content: application/json: schema: $ref: '#/components/schemas/GeneralSurveySingleResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Survey not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] components: schemas: GeneralSurveySingleResponse: type: object properties: data: $ref: '#/components/schemas/GeneralSurveyDetail' required: - data 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 GeneralSurveyDetail: allOf: - $ref: '#/components/schemas/GeneralSurvey' - type: object properties: questions: type: array items: $ref: '#/components/schemas/SurveyQuestion' description: Survey questions required: - questions GeneralSurvey: type: object properties: id: type: string description: Survey identifier title: type: string description: Survey title description: type: string nullable: true description: Survey description isActive: type: boolean description: Whether the survey is active publishedAt: type: string nullable: true format: date-time description: Publication timestamp version: type: number description: Survey version questionCount: type: number description: Number of questions responseCount: type: number description: Number of responses createdAt: type: string format: date-time description: Creation timestamp (ISO 8601) updatedAt: type: string format: date-time description: Last update timestamp (ISO 8601) required: - id - title - description - isActive - publishedAt - version - questionCount - responseCount - createdAt - updatedAt SurveyQuestion: type: object properties: id: type: string description: Question identifier questionText: type: string description: Question text answerType: type: string enum: - short_text - long_text - single_select - multi_select - likert - numeric_slider - boolean - date - rating_stars - nps description: Type of answer expected displayOrder: type: number description: Display order isRequired: type: boolean description: Whether the question is required isActive: type: boolean description: Whether the question is active options: type: array items: $ref: '#/components/schemas/SurveyQuestionOption' description: Answer options (for select questions) createdAt: type: string format: date-time description: Creation timestamp (ISO 8601) updatedAt: type: string format: date-time description: Last update timestamp (ISO 8601) required: - id - questionText - answerType - displayOrder - isRequired - isActive - options - createdAt - updatedAt SurveyQuestionOption: type: object properties: id: type: string description: Option identifier value: type: string description: Option value/text displayOrder: type: number description: Display order required: - id - value - displayOrder 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. ````