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
The page number to retrieve.
The number of records per page.
The property name to sort results by (e.g.
Name, CreatedOn).Sort direction.
0 for ascending, 1 for descending.Filters
Filter by iD of the coworker linked to this record.
Filter by the coworker coworker type value for this form page request.
Filter by display name of the linked coworker full (read-only).
Filter by display name of the linked coworker company (read-only).
Filter by display name of the linked coworker billing (read-only).
Filter by the coworker email value for this form page request.
Filter by iD of the form page linked to this record.
Filter by display name of the linked form page (read-only).
Filter by display name of the linked form page business (read-only).
Filter by date/time value for sent on.
Filter by whether submitted is enabled.
Filter by iD of the event attendee unique associated with this record.
Filter by iD of the calendar event unique associated with this record.
Filter by iD of the coworker contract unique associated with this record.
Range Filters
Filter by date/time value for sent on greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by date/time value for sent on less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter records created on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records created on or before this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or before this date. Format:
YYYY-MM-DDTHH:mm.Code Examples
Simple listing
Filtering by CreatedOn
Range filters
Response
200
The list of FormPageRequest records matching the query. See the Get one FormPageRequest endpoint for the full list of properties returned for each record.
Current page number.
Number of records per page.
The field used for sorting.
The sort direction (
0 = ascending, 1 = descending).Index of the first item on the current page.
Index of the last item on the current page.
Total number of matching records across all pages.
Total number of pages.
Whether there is a next page of results.
Whether there is a previous page of results.
Example Response
Search FormPageRequests