Surveys
Create New Survey
POST surveys/newSurvey
Creates a new survey that can be sent to users and stakeholders.
Parameters
| token | API Token. |
|---|---|
| whitelabel_id | Whitelabel Id of the organization. |
| description | Description of the survey. |
| anonymous | `Yes` or `No` - Whether or not the responses are anonymous. |
| public | `Yes` or `No` - Whether or not the results will be available to all users. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:| Id | Name | Description |
|---|---|---|
| 19 | Manage Surveys | Allowed to create and send surveys to the entire organization. |
Sample Responses
[]
[]
Success Response Key
Get All Surveys
GET surveys/getAllSurveys
Retrieves all surveys in the organization.
Required Permissions
No special permissions required to access this endpoint.Sample Responses
[]
[]
Success Response Key
Get Draft Surveys
GET surveys/getDraftSurveys
Retrieves all surveys that have not been sent to recipients yet.
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:| Id | Name | Description |
|---|---|---|
| 19 | Manage Surveys | Allowed to create and send surveys to the entire organization. |
Sample Responses
[]
[]
Success Response Key
Get Survey By Id
GET surveys/getSurvey
Retrieves a survey by its survey_id ID number.
Parameters
| token | API Token. |
|---|---|
| whitelabel_id | Whitelabel Id of the organization. |
| survey_id | Id of the survey to get. |
Required Permissions
No special permissions required to access this endpoint.Sample Responses
[]
[]
Success Response Key
Update Survey Attribute
POST surveys/updateSurveyAttribute
Updates metadata about a given survey.
Parameters
| token | API Token. |
|---|---|
| whitelabel_id | Whitelabel Id of the organization. |
| survey_id | Id of the survey being updated. |
| title | (optional) New title for the survey. |
| description | (optional) Description of the survey. |
| anonymous | (optional) `Yes` or `No` - Whether or not the responses are anonymous. |
| public | (optional) `Yes` or `No` - Whether or not the results will be available to all users. |
| open_time | (optional) UNIX timestamp of when the survey opens for users to take. |
| close_time | (optional) UNIX timestamp of when the survey closes to new responses. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:| Id | Name | Description |
|---|---|---|
| 19 | Manage Surveys | Allowed to create and send surveys to the entire organization. |
Sample Responses
[]
[]
Success Response Key
Add Description Element To Survey
POST surveys/addDescriptionElementToSurvey
Adds a block of text onto the body of the survey. This is typically used to add descriptions, instructions, or general details for the user.
Parameters
| token | API Token. |
|---|---|
| whitelabel_id | Whitelabel Id of the organization. |
| survey_id | Id of the survey being updated. |
| text | Text to add to the survey. This can be HTML code. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:| Id | Name | Description |
|---|---|---|
| 19 | Manage Surveys | Allowed to create and send surveys to the entire organization. |
Sample Responses
[]
[]
Success Response Key
Add Text Element To Survey
POST surveys/addTextElementToSurvey
Creates a text field on the body of the survey for the user to input a response. The label parameter should describe what
the user needs to provide in the text field.
Parameters
| token | API Token. |
|---|---|
| whitelabel_id | Whitelabel Id of the organization. |
| survey_id | Id of the survey being updated. |
| label | Label for the text box (i.e. what question are you asking the user?). |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:| Id | Name | Description |
|---|---|---|
| 19 | Manage Surveys | Allowed to create and send surveys to the entire organization. |
Sample Responses
[]
[]
Success Response Key
Add Dropdown Element To Survey
POST surveys/addDropdownElementToSurvey
Adds a dropdown menu to the body of the survey. The dropdown can have up to 20 items to select in the menu.
Parameters
| token | API Token. |
|---|---|
| whitelabel_id | Whitelabel Id of the organization. |
| survey_id | Id of the survey being updated. |
| label | Label for the dropdown (i.e. what question are you asking the user?). |
| selection_1 | 1st dropdown item. |
| selection_2 | 2nd dropdown item. |
| selection_3 | (optional) 3rd dropdown item |
| selection_4 | (optional) 4th dropdown item |
| selection_5 | (optional) 5th dropdown item |
| selection_6 | (optional) 6th dropdown item |
| selection_7 | (optional) 7th dropdown item |
| selection_8 | (optional) 8th dropdown item |
| selection_9 | (optional) 9th dropdown item |
| selection_10 | (optional) 10th dropdown item |
| selection_11 | (optional) 11th dropdown item |
| selection_12 | (optional) 12th dropdown item |
| selection_13 | (optional) 13th dropdown item |
| selection_14 | (optional) 14th dropdown item |
| selection_15 | (optional) 15th dropdown item |
| selection_16 | (optional) 16th dropdown item |
| selection_17 | (optional) 17th dropdown item |
| selection_18 | (optional) 18th dropdown item |
| selection_19 | (optional) 19th dropdown item |
| selection_20 | (optional) 20th dropdown item |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:| Id | Name | Description |
|---|---|---|
| 19 | Manage Surveys | Allowed to create and send surveys to the entire organization. |
Sample Responses
[]
[]
Success Response Key
Delete Survey Element
POST surveys/deleteSurveyElement
Deletes a given element from the body of the survey.
Parameters
| token | API Token. |
|---|---|
| whitelabel_id | Whitelabel Id of the organization. |
| survey_id | Id of the survey being updated. |
| question_id | Id of the survey element to remove from the survey. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:| Id | Name | Description |
|---|---|---|
| 19 | Manage Surveys | Allowed to create and send surveys to the entire organization. |
Sample Responses
[]
[]
Success Response Key
Swap Element Positions
POST surveys/swapQuestionPositions
Swaps the position of two elements in the body of the survey.
Parameters
| token | API Token. |
|---|---|
| whitelabel_id | Whitelabel Id of the organization. |
| survey_id | Id of the survey being updated. |
| question_id_1 | Id of the element to swap with the second element. |
| question_id_2 | Id of the element to swap with the first element. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:| Id | Name | Description |
|---|---|---|
| 19 | Manage Surveys | Allowed to create and send surveys to the entire organization. |
Sample Responses
[]
[]
Success Response Key
Add Group To Recipients List
POST surveys/addGroupToRecipients
Adds an entire group of users to the recipients list of the survey. Optionally, the stakeholders of the group can also be added.
Parameters
| token | API Token. |
|---|---|
| whitelabel_id | Whitelabel Id of the organization. |
| survey_id | Id of the survey being updated. |
| group_id | Id of the group to add to the recipients list. |
| stakeholders | (optional) `Yes` or `No` - Whether to include the groups stakeholders (if any) |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:| Id | Name | Description |
|---|---|---|
| 19 | Manage Surveys | Allowed to create and send surveys to the entire organization. |
Sample Responses
[]
[]
Success Response Key
Add User To Recipients List
POST surveys/addUserToRecipients
Adds an individual user to the recipients list of the survey.
Parameters
| token | API Token. |
|---|---|
| whitelabel_id | Whitelabel Id of the organization. |
| survey_id | Id of the survey being updated. |
| custid | Custid of the user being added as a recipient. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:| Id | Name | Description |
|---|---|---|
| 19 | Manage Surveys | Allowed to create and send surveys to the entire organization. |
Sample Responses
[]
[]
Success Response Key
Remove Recipient
POST surveys/removeRecipient
Removes a given recipient from the recipients list.
Parameters
| token | API Token. |
|---|---|
| whitelabel_id | Whitelabel Id of the organization. |
| survey_id | Id of the survey being updated. |
| recipient_id | Id of the recipient to remove from the survey. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:| Id | Name | Description |
|---|---|---|
| 19 | Manage Surveys | Allowed to create and send surveys to the entire organization. |
Sample Responses
[]
[]
Success Response Key
Mark Ready To Send
POST surveys/markReadyToSend
Marks a given survey as ready to send to all recipients. The survey will still wait to send until the start time of the survey,
but after the start time passes, it will be available for users to view and submit.
Parameters
| token | API Token. |
|---|---|
| whitelabel_id | Whitelabel Id of the organization. |
| survey_id | Id of the survey being marked Ready to Send. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:| Id | Name | Description |
|---|---|---|
| 19 | Manage Surveys | Allowed to create and send surveys to the entire organization. |
Sample Responses
[]
[]
Success Response Key
Get Surveys For User
GET surveys/getMySurveys
Retrieves all surveys the authenticated user is allowed to view results or submit new responses for.
Required Permissions
No special permissions required to access this endpoint.Sample Responses
[]
[]
Success Response Key
Get Public Survey Results
GET surveys/getPublicResults
Required Permissions
No special permissions required to access this endpoint.Sample Responses
[]
[]
Success Response Key
Delete Survey
POST surveys/deleteSurvey
Deletes a survey and all associated submissions
Parameters
| token | API Token. |
|---|---|
| whitelabel_id | Whitelabel Id of the organization. |
| survey_id | Id of the survey to delete. |
Required Permissions
The authenticated user must hold one of the following permissions to access this endpoint:| Id | Name | Description |
|---|---|---|
| 19 | Manage Surveys | Allowed to create and send surveys to the entire organization. |
Sample Responses
[]
[]