← Tools Reference

Formsite

Formsite integration (Productivity, Data). Imported from open-connector.

API key7 tools{api_base_url}
GET
formsite_list_forms
List all forms available in the connected Formsite account user directory.

/forms

1 parameter
ParamTypeRequiredDescription
user_dirstringoptionalOptional Formsite user directory. When omitted, the connected default userDir i…
GET
formsite_get_form
Get one Formsite form by its form directory identifier.

/{userDir}/forms/{form_dir}

3 parameters
ParamTypeRequiredDescription
form_dirstringrequiredThe form directory identifier to retrieve.
user_dirstringoptionalOptional Formsite user directory. When omitted, the connected default userDir i…
userDirstringrequiredPath parameter: userDir
GET
formsite_get_form_items
List the item definitions for one Formsite form.

/{userDir}/forms/{form_dir}/items

4 parameters
ParamTypeRequiredDescription
form_dirstringrequiredThe form directory identifier whose items should be listed.
user_dirstringoptionalOptional Formsite user directory. When omitted, the connected default userDir i…
results_labelsstringoptionalOptional results labels ID to apply when reading item labels.
userDirstringrequiredPath parameter: userDir
GET
formsite_get_form_results
List results for one Formsite form with pagination, date windows, result ID windows, and upstream search filters.

/{userDir}/forms/{form_id}/results

18 parameters
ParamTypeRequiredDescription
form_dirstringoptionalOptional alias for the form directory identifier. form_id is preferred and wins…
form_idstringrequiredThe form directory identifier whose results should be listed.
user_dirstringoptionalOptional Formsite user directory. When omitted, the connected default userDir i…
limitintegeroptionalMaximum number of results to return, up to 500.
pageintegeroptionalThe page number to request.
after_datestringoptionalOnly return results updated after this timestamp or local datetime string.
before_datestringoptionalOnly return results updated before this timestamp or local datetime string.
after_idstringoptionalOnly return results whose IDs are greater than this result ID.
before_idstringoptionalOnly return results whose IDs are less than this result ID.
sort_idstringoptionalOptional item or meta field identifier to use as the upstream sort key.
results_viewstringoptionalOptional results view identifier to apply.
sort_directionstringoptionalThe upstream result sort direction.
search_methodstringoptionalHow multiple search clauses should be combined.
search_equalsobjectoptionalA map from Formsite item or meta field IDs to search values, encoded as search_…
search_containsobjectoptionalA map from Formsite item or meta field IDs to search values, encoded as search_…
search_beginsobjectoptionalA map from Formsite item or meta field IDs to search values, encoded as search_…
search_endsobjectoptionalA map from Formsite item or meta field IDs to search values, encoded as search_…
userDirstringrequiredPath parameter: userDir
GET
formsite_list_webhooks
List all webhooks configured for one Formsite form.

/{userDir}/forms/{form_dir}/webhooks

3 parameters
ParamTypeRequiredDescription
form_dirstringrequiredThe form directory identifier whose webhooks should be listed.
user_dirstringoptionalOptional Formsite user directory. When omitted, the connected default userDir i…
userDirstringrequiredPath parameter: userDir
POST
formsite_upsert_webhook
Create a new Formsite webhook, or update the existing webhook that matches the same URL.

/{userDir}/forms/{form_dir}/webhooks

6 parameters
ParamTypeRequiredDescription
form_dirstringrequiredThe form directory identifier whose webhook should be created or updated.
user_dirstringoptionalOptional Formsite user directory. When omitted, the connected default userDir i…
eventstringrequiredThe event name to subscribe, such as result_completed.
urlstringrequiredThe webhook destination URL.
handshake_keystringoptionalOptional handshake key to include in deliveries.
userDirstringrequiredPath parameter: userDir
DELETE
formsite_delete_webhook
Delete one Formsite webhook from a form by its destination URL.

/{userDir}/forms/{form_dir}/webhooks

4 parameters
ParamTypeRequiredDescription
form_dirstringrequiredThe form directory identifier whose webhook should be deleted.
user_dirstringoptionalOptional Formsite user directory. When omitted, the connected default userDir i…
urlstringrequiredThe webhook URL to delete from the form.
userDirstringrequiredPath parameter: userDir