Get Poll Responses

Get poll responses

Path Parameters

companyID companyID required

The id of the company

pollID pollID required

The id of the poll

date date required

The date the poll was sent

Responses

• 200
• 404

---

List of poll responses

application/json

Schema

Example (from schema)

---

Schema

surveyTemplateID string

Unique ID of the survey template

surveyTitle string

Title of the survey

anonymous boolean

Whether the survey is anonymous

questions object[]
List of elements in the survey template
Array [
type string
Possible values: [text, radio, select, dateRange]
Type of the survey element
label string
Label of the survey element
helperText string nullable
Helper text of the survey element
required boolean
Whether a response is required
]
responses object[]
List of survey responses
Array [
id string nullable
Unique ID of the user (if survey is not anonymous)
responses object[]
List of the user responses
Array [
oneOf
MOD1
MOD2
---
string
boolean
]
]

{
  "surveyTemplateID": "2e8f9915-fda0-450c-95a3-d61f93c66fa9",
  "surveyTitle": "How was the event?",
  "anonymous": true,
  "questions": [
    {
      "type": "text",
      "label": "What's your favorite color?",
      "helperText": "Choose one of the colors",
      "required": true
    }
  ],
  "responses": [
    {
      "id": "2e8f9915-fda0-450c-95a3-d61f93c66fa9",
      "responses": [
        "string",
        true
      ]
    }
  ]
}

An error when the poll is not found

application/json

Schema

Example (from schema)

---

Schema

message string

Error message

{
  "message": "User not found"
}

Loading...