Get survey contents

GET 
/:customer_id/users/:uid/surveys/:survey_id

Get the contents of a survey

Request

Path Parameters

customer_id Customer Idrequired

Id of the tenant

uid uuidrequired

Id of the user

survey_id Survey Idrequired

Query Parameters

lang Lang

Default value: en

Langauge code. Ex: en-US

Responses

200

application/json

Schema

Schema

id Idrequired
title Titlerequired
description Descriptionrequired
questions object[]required
Array [
id Idrequired
title Titlerequired
Title of the question
text Textrequired
Complementary text to the question
answer_type Answer Typerequired
Possible values: [numeric, text, single_choice, single_choice_with_other, multiple_choice, multiple_choice_with_other]
options object[]nullablerequired
Array [
id Idrequired
text Textrequired
]
extras object nullable
Optional extra details about the question
anyOf
SliderExtras
subtype Subtyperequired
Possible values: [slider]
min Minrequired
max Maxrequired
step Steprequired
]

Example (from schema)

{
  "id": "string",
  "title": "string",
  "description": "string",
  "questions": [
    {
      "id": "string",
      "title": "string",
      "text": "string",
      "answer_type": "numeric",
      "options": [
        {
          "id": "string",
          "text": "string"
        }
      ],
      "extras": {}
    }
  ]
}

400

Validation error

application/json

Schema

Schema

message Messagerequired
errors undefined[]nullablerequired

Example (from schema)

{
  "message": "string",
  "errors": [
    null
  ]
}

Loading...