FormPageAnswers
Search FormPageAnswers
Search and list FormPageAnswer records with filtering, sorting, and pagination.
GET
Search FormPageAnswers
A form answer (FormPageAnswer) is a read-only customer response to one form question. Answers are created by the public submission workflow and can be reviewed with their request, question, and associated event or contract context.
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 FormPageAnswer-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 form request that contains this submitted answer.
string
Filter by display value for FormPageRequest.Coworker.FullName..
integer
Filter by display value for FormPageRequest.Coworker.Id..
string
Filter by display value for FormPageRequest.Coworker.Email..
integer
Filter by iD of the form question answered by the customer; the question’s form location owns this answer.
string
Filter by display value for FormPageQuestion.Text..
string
Filter by display value for FormPageQuestion.QuestionType..
integer
Filter by display value for FormPageQuestion.DisplayOrder..
string
Filter by display value for FormPageQuestion.FormPage.Name..
integer
Filter by display value for FormPageQuestion.FormPage.Id..
integer
Filter by display value for FormPageQuestion.FormPage.Business.Id..
string
Filter by display value for FormPageQuestion.FormPage.Business.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.
string
Filter by system-managed unique ID linking this answer to an event attendee; set by the event workflow and never supplied by an agent.
string
Filter by system-managed unique ID linking this answer to an event; set by the event workflow and never supplied by an agent.
string
Filter by system-managed unique ID linking this answer to a customer contract; set by the contract workflow and never supplied by an agent.
Range Filters
integer
Filter by display value for FormPageRequest.Coworker.Id. greater than or equal to this value.
integer
Filter by display value for FormPageRequest.Coworker.Id. less than or equal to this value.
integer
Filter by display value for FormPageQuestion.DisplayOrder. greater than or equal to this value.
integer
Filter by display value for FormPageQuestion.DisplayOrder. less than or equal to this value.
integer
Filter by display value for FormPageQuestion.FormPage.Id. greater than or equal to this value.
integer
Filter by display value for FormPageQuestion.FormPage.Id. less than or equal to this value.
integer
Filter by display value for FormPageQuestion.FormPage.Business.Id. greater than or equal to this value.
integer
Filter by display value for FormPageQuestion.FormPage.Business.Id. less than or equal to this value.
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
FormPageAnswer[]
The list of FormPageAnswer records matching the query. See the Get one FormPageAnswer 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