SurveyAnswers
Search SurveyAnswers
Search and list SurveyAnswer records with filtering, sorting, and pagination.
GET
Search SurveyAnswers
A survey answer (SurveyAnswer) is a read-only customer response to one survey question. Answers are created by the public survey submission workflow and can be reviewed with their survey run and question.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the SurveyAnswer-List role.Query Parameters
Pagination & Sorting
integer
default:"1"
The page number to retrieve.
integer
default:"25"
The number of records per page.
string
The property name to sort results by (e.g.
Name, CreatedOn).integer
Sort direction.
0 for ascending, 1 for descending.Filters
integer
Filter by iD of the survey run that contains this submitted answer.
integer
Filter by iD of the survey question answered by the customer; the question’s survey location owns this answer.
string
Filter by display value for SurveyQuestion.Text..
string
Filter by display value for SurveyQuestion.Survey.Name..
string
Filter by customer’s submitted answer text; for a Binary question this is the stored filename rather than file content.
string
Filter by current file name of the file value (read-only; upload via the corresponding URL field).
string
Filter by uRL of a new file to upload as the file value.
boolean
Filter by set to true to remove the current file value file.
Range Filters
string
Filter records created on or after this date. Format:
YYYY-MM-DDTHH:mm.string
Filter records created on or before this date. Format:
YYYY-MM-DDTHH:mm.string
Filter records updated on or after this date. Format:
YYYY-MM-DDTHH:mm.string
Filter records updated on or before this date. Format:
YYYY-MM-DDTHH:mm.Code Examples
Simple listing
Filtering by CreatedOn
Range filters
Response
200
SurveyAnswer[]
The list of SurveyAnswer records matching the query. See the Get one SurveyAnswer endpoint for the full list of properties returned for each record.
integer
Current page number.
integer
Number of records per page.
string
The field used for sorting.
integer
The sort direction (
0 = ascending, 1 = descending).integer
Index of the first item on the current page.
integer
Index of the last item on the current page.
integer
Total number of matching records across all pages.
integer
Total number of pages.
boolean
Whether there is a next page of results.
boolean
Whether there is a previous page of results.
Example Response