Skip to content

Get Survey Info by Code

This endpoint will get basic survey information from a code.

Request

GET /survey-codes/{code}
  • code is a six-character alphanumeric value.

Authorization

No authorization necessary for this endpoint

Headers

N/A

Query Parameters

N/A

Response

Response Status Code More Information
Success 200 Survey exists with the provided code. Response body will have details
Not Found 404 Survey does not exist with the provided code
Internal Server Error 500 Unknown error

Headers

N/A

Body

{
    "uuid": "<survey-uuid>",
    "title": "<survey-title>",
    "subtitle": "<survey-subtitle>",
    "surveyTimeEstimateInMinutes": <int>,
    "accountUUID": "<account-uuid>",
    "accountName": "<account-name>",
    "accountAddress": {
        "streetAddress": "<street-address>",
        "suite": "<suite>",
        "city": "<city>",
        "state": "<state>",
        "zipCode": "<zipCode>"
    },
    "patientName": "<patient-name>"
}

Note

The uuid of the survey will be used on any other endpoints when referencing the survey