v1
latestOpenAPI 3.1.02026-07-2466150275.0 KBForm Instances
Get Raw Digital Forms in Bulk
Get the contents of multiple form instances for the same form in a format suitable for business analytics applications.
This endpoint is different from Get Digital Form in a couple ways:
- It returns the contents of multiple forms instances.
- If the form template has changed since the form instance was submitted, this will use the structure of the form template. If fields were deleted in the form template, they will not be returned, even if the form instance contains that field.
- Fields that refer to another object (Asset, Document, Site or User) are the the name of that object.
- Attachments and tables are empty values.
get/v1/form-instance/bulk/{form_id}/
Path parameters
form_idinteger required
Query parameters
skipinteger nullable
limitinteger nullable
sort_direction'asc' | 'desc'
Direction to sort the sort_column - ascending or descending.
sort_column'updated_at' | 'created_at' | 'id'
Which column to sort on
date_startstring date-time nullable
date_cut_offstring date-time nullable
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.
submitted_user_idinteger nullable
Response
Successful Response
Example response
{
"data": {
"headers": {
"attachment_1750273781805998": "Site Photo",
"decimal_17502731666394148": "Hours Worked",
"site_17502732474758524": "Work Site",
"table_17502732900583641": "Issue Checklist",
"text_17502731460635039": "Work Order"
},
"data": [
{
"decimal_17502731666394148": 8.5,
"site_17502732474758524": "Cedar Grove Community Center",
"text_17502731460635039": "abc-123"
},
{
"decimal_17502731666394148": 4,
"site_17502732474758524": "Downtown Highrise",
"text_17502731460635039": "def-456"
}
]
}
}