---
title: "Read Survey"
method: GET
path: "/workspaces/{workspace_id}/surveys/{survey_id}"
tags: ["surveys"]
---

# Read Survey

`GET /workspaces/{workspace_id}/surveys/{survey_id}`

## Request

- Base URL: `https://api.useauxos.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.useauxos.com/workspaces/{workspace_id}/surveys/{survey_id}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/useauxos/apis/auxos/docs/workspaces/:workspace_id/surveys/:survey_id/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `survey_id` string, uuid, required
- `workspace_id` string, uuid, required

## Response `200`

Successful Response

- SurveyReadResponse
  - `survey` SurveyDetail, required
    - `id` string, uuid, required
    - `owner_id` string, uuid, required
    - `workspace_id` string, uuid, required
    - `population_id` string, uuid, required
    - `name` string, required
    - `context` string, nullable
    - `status` 'draft' | 'running' | 'completed' | 'failed', required
    - `started_at` string, nullable
    - `completed_at` string, nullable
    - `demographic_filter` object, nullable
    - `created_at` string, required
    - `updated_at` string, required
    - `populations` SurveyPopulationRef
      - `id` string, uuid, required
      - `name` string, required
      - `subtitle` string, nullable
    - `survey_sections` SurveySectionDetail[], required
      - `id` string, uuid, required
      - `survey_id` string, uuid, required
      - `position` integer, required
      - `section_type` 'question_group' | 'concept_test', required
      - `concept_category` 'creatives' | 'messaging' | 'scenarios' | 'websites', required
      - `title` string, required
      - `created_at` string, required
      - `updated_at` string, required
      - `survey_concepts` SurveyConceptDetail[], required
        - `id` string, uuid, required
        - `survey_id` string, uuid, required
        - `section_id` string, uuid, required
        - `position` integer, required
        - `name` string, required
        - `body` string, nullable
        - `asset_id` string, uuid, nullable
        - `image_url` string, nullable
        - `created_at` string, required
        - `updated_at` string, required
      - `survey_questions` SurveyQuestionDetail[], required
        - `id` string, uuid, required
        - `survey_id` string, uuid, required
        - `section_id` string, uuid, required
        - `position` integer, required
        - `key` string, required
        - `type` 'open_ended' | 'multiple_choice' | 'scale' | 'ranking', required
        - `question` string, required
        - `asset_id` string, uuid, nullable
        - `image_url` string, nullable
        - `answer_config` object, required
        - `rationale_summary` RationaleSummary
          - `by_concept` object
        - `created_at` string, required
        - `updated_at` string, required
    - `survey_responses` SurveyResponseDetail[], required
      - `id` string, uuid, required
      - `survey_id` string, uuid, required
      - `section_id` string, uuid, required
      - `question_id` string, uuid, required
      - `concept_id` string, uuid, nullable
      - `persona_id` string, uuid, required
      - `answer_text` string, nullable
      - `answer_number` number, nullable
      - `answer_choices` string[], nullable
      - `rationale` string, nullable
      - `raw_response` unknown
      - `created_at` string, required
    - `survey_persona_failures` SurveyPersonaFailureDetail[], required
      - `id` string, uuid, required
      - `survey_id` string, uuid, required
      - `section_id` string, uuid, nullable
      - `question_id` string, uuid, nullable
      - `concept_id` string, uuid, nullable
      - `persona_id` string, uuid, required
      - `error_message` string, required
      - `created_at` string, required
    - `response_count` integer, required
    - `expected_response_count` integer, required
    - `persona_count` integer, required
    - `failure_count` integer, required
    - `rationale_summary_total` integer, required
    - `rationale_summary_done` integer, required
    - `rollups` SurveyQuestionRollup[], required
      - `questionId` string, uuid, required
      - `questionKey` string, required
      - `type` 'open_ended' | 'multiple_choice' | 'scale' | 'ranking', required
      - `answerConfig` object, required
      - `concepts` SurveyConceptRollup[], required
        - `conceptId` string, uuid, nullable
        - `conceptName` string, nullable
        - `responseCount` integer, required
        - `averageNumber` number, nullable
        - `numericPercentiles` object[]
        - `numberDistribution` object[]
        - `choiceCounts` object[]
        - `textAnswers` object[]
        - `rankingOptions` SurveyRankingOption[]
          - `ref` string, required
          - `label` string, nullable
          - `assetId` string, nullable
          - `imageUrl` string, nullable
          - `distribution` integer[], required
          - `top1Count` integer, required
          - `meanRank` number, nullable
          - `responseCount` integer, required
          - `rationaleCount` integer, required
    - `can_write` boolean, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/useauxos/apis/auxos.md) - [All operations](https://skmtc.dev/useauxos/apis/auxos/llms.txt) - [OpenAPI document](https://skmtc.dev/useauxos/apis/auxos/revisions/2f853c0b59f4?raw)