FormPageQuestions
Search FormPageQuestions
Search and list FormPageQuestion records with filtering, sorting, and pagination.
GET
Search FormPageQuestions
A form question (FormPageQuestion) is an ordered question within a location’s customer form. It defines the customer-facing label, explanation, input type, optional choices, and whether the question is shown or required.
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 FormPageQuestion-List role.Enums
eQuestionType — QuestionType values
eQuestionType — QuestionType values
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 that contains this question; the form’s location determines access to the question.
string
Filter by display value for FormPage.Name..
string
Filter by required question label shown to customers.
string
Filter by required explanatory text shown below the question to customers.
string
Filter by comma-separated choices for a Dropdown question; leave empty for other question types.
boolean
Filter by whether this question appears in the customer-facing form.
integer
Filter by integer position for displaying this question; lower values appear first and the system renumbers questions after create or update.
boolean
Filter by whether customers can select more than one choice for a Dropdown question.
boolean
Filter by whether the customer-facing form marks an answer to this question as required.
integer
Filter by controls the customer input: Text, Boolean (Yes/No), LongText, Date, Dropdown, or Binary file upload; defaults to Text.
Range Filters
integer
Filter by integer position for displaying this question; lower values appear first and the system renumbers questions after create or update greater than or equal to this value.
integer
Filter by integer position for displaying this question; lower values appear first and the system renumbers questions after create or update 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 Text
Range filters
Response
200
FormPageQuestion[]
The list of FormPageQuestion records matching the query. See the Get one FormPageQuestion 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