FormPageRequests
Search FormPageRequests
Search and list FormPageRequest records with filtering, sorting, and pagination.
GET
Search FormPageRequests
A FormPageRequest represents a single submission of a form page by a customer. It groups all the answers provided in one form session and tracks which customer submitted it and when.
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 FormPageRequest-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 coworker linked to this record.
string
Filter by the coworker coworker type value for this form page request.
string
Filter by display name of the linked coworker full (read-only).
string
Filter by display name of the linked coworker company (read-only).
string
Filter by display name of the linked coworker billing (read-only).
string
Filter by the coworker email value for this form page request.
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 display name of the linked form page business (read-only).
string
Filter by date/time value for sent on.
boolean
Filter by whether submitted is enabled.
string
Filter by iD of the event attendee unique associated with this record.
string
Filter by iD of the calendar event unique associated with this record.
string
Filter by iD of the coworker contract unique associated with this record.
Range Filters
string
Filter by date/time value for sent on greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by date/time value for sent on less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.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
FormPageRequest[]
The list of FormPageRequest records matching the query. See the Get one FormPageRequest 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
Search FormPageRequests