Skip to main content
GET
Search FormPageQuestions
A FormPageQuestion defines a single question within a form page, including its type (text, boolean, dropdown, etc.), label, validation rules, and display order.

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

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 page linked to this record.
string
Filter by display name of the linked form page (read-only).
string
Filter by the text value for this form page question.
string
Filter by free-text description of this form page question.
string
Filter by the available options value for this form page question.
boolean
Filter by whether this form page question is currently active.
integer
Filter by the display order value for this form page question.
boolean
Filter by whether allow multiple options is enabled.
boolean
Filter by whether is required is enabled.
integer
Filter by the question type value for this form page question.

Range Filters

integer
Filter by the display order value for this form page question greater than or equal to this value.
integer
Filter by the display order value for this form page question 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.
Partial records — The listing endpoint returns a summary representation of each FormPageQuestion. The following fields are not populated in the Records[] response: QuestionType.To get all fields, fetch the full record using the Get one FormPageQuestion endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.
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