Survey
Private Survey API endpoints
Endpoints
Get a specific survey by ID. Questions, their answers, and each answer's stock_count are always included, so the expand parameter is not required and does not change the response.
Path parameters
survey_idRequiredintegerSurvey ID
Query parameters
expand[]optionalstring[]List of relations to expand in the response.
ReturnsSurvey
Survey object response
Response
Surveys are always returned with their questions, each question's answers, and each answer's stock_count. The expand parameter is not needed for these relations and changes nothing in the response.
Query parameters
expand[]optionalstring[]List of relations to expand. This endpoint accepts only the exact value questions; nested paths such as questions.answers are rejected with 422 here, although they are accepted on GET /surveys/{survey_id}.
queryoptionalstringSearch query
ReturnsSurvey[]
Surveys list response
Response