v1
latestOpenAPI 3.1.02026-07-2466150275.0 KBForm Instances
Search Form Instances
Search for forms that match the provided search terms.
Keywords are searched for in the title, instance identifier, site identifier, site name, site address, company name, submitted user first and last name, draft name, device name, and device type fields.
get/v1/form-instance/
Query parameters
querystring nullable
skipinteger nullable
limitinteger nullable
sort_direction'asc' | 'desc'
Direction to sort the sort_column - ascending or descending.
date_startstring date-time nullable
date_cut_offstring date-time nullable
sort_column'updated_at' | 'created_at' | 'id'
Which column to sort on
query_mode'own' | 'shared'
Specify the search mode for the form instances.
external_project_idstring nullable
external_company_idstring nullable
external_onlyboolean nullable
project_idinteger nullable
form_instance_status'draft' | 'draft_pending_review' | 'pending_review' | 'completed' | 'disapproved'
The status of the form instances.
form_idinteger nullable
form_type_idinteger nullable
submitted_user_idinteger nullable
created_by_user_idinteger nullable
signer_user_idinteger nullable
is_restrictedboolean nullable
is_archivedboolean nullable
has_corrective_actionboolean nullable
incident_idinteger nullable
has_public_accessboolean nullable
Response
Successful Response