Survey API

get /surveys/{survey_code}/responses

Get survey responses

Base URL https://api-ms.vsee.me/api · operationId getSurveyResponses

Authentication: User Token — Requires a user access token from login or SSO.

Retrieve survey responses based on survey code and optional filters

Parameters

Name	In	Type	Required	Enum	Default	Description
X-ApiToken	header	string	yes			API token (e.g. your_api_token)
survey_code	path	string	yes	all, cancel_intake_survey, provider_visit_survey, cancel_call_survey, post_visit_survey		Survey code to filter responses. Use 'all' to retrieve all surveys
from_time	query	integer	no			UNIX timestamp for start of search period
to_time	query	integer	no			UNIX timestamp for end of search period
clinic_codes	query	string	no			Comma-separated list of clinic codes to filter
visit_ids	query	string	no			Comma-separated list of visit IDs to filter

Responses

200 — Survey responses retrieved successfully

cancelCallSurvey

{
  "data": [
    {
      "id": "62685d75-b290-4e71-9bf6-33e464457b11",
      "survey_code": "cancel_call_survey",
      "clinic_code": "vclinic",
      "visit_id": "22183940",
      "intake_id": "",
      "room_code": "",
      "user_id": "16811538",
      "data": {
        "reason": "test_call",
        "member_id": "21728487",
        "provider_id": "0"
      },
      "created": 1651006837
    }
  ],
  "total_count": 1131
}

Machine-readable: OpenAPI JSON (operationId: getSurveyResponses)