Formsite integration (Productivity, Data). Imported from open-connector.
{api_base_url}/forms
| Param | Type | Required | Description |
|---|---|---|---|
| user_dir | string | optional | Optional Formsite user directory. When omitted, the connected default userDir i… |
/{userDir}/forms/{form_dir}
| Param | Type | Required | Description |
|---|---|---|---|
| form_dir | string | required | The form directory identifier to retrieve. |
| user_dir | string | optional | Optional Formsite user directory. When omitted, the connected default userDir i… |
| userDir | string | required | Path parameter: userDir |
/{userDir}/forms/{form_dir}/items
| Param | Type | Required | Description |
|---|---|---|---|
| form_dir | string | required | The form directory identifier whose items should be listed. |
| user_dir | string | optional | Optional Formsite user directory. When omitted, the connected default userDir i… |
| results_labels | string | optional | Optional results labels ID to apply when reading item labels. |
| userDir | string | required | Path parameter: userDir |
/{userDir}/forms/{form_id}/results
| Param | Type | Required | Description |
|---|---|---|---|
| form_dir | string | optional | Optional alias for the form directory identifier. form_id is preferred and wins… |
| form_id | string | required | The form directory identifier whose results should be listed. |
| user_dir | string | optional | Optional Formsite user directory. When omitted, the connected default userDir i… |
| limit | integer | optional | Maximum number of results to return, up to 500. |
| page | integer | optional | The page number to request. |
| after_date | string | optional | Only return results updated after this timestamp or local datetime string. |
| before_date | string | optional | Only return results updated before this timestamp or local datetime string. |
| after_id | string | optional | Only return results whose IDs are greater than this result ID. |
| before_id | string | optional | Only return results whose IDs are less than this result ID. |
| sort_id | string | optional | Optional item or meta field identifier to use as the upstream sort key. |
| results_view | string | optional | Optional results view identifier to apply. |
| sort_direction | string | optional | The upstream result sort direction. |
| search_method | string | optional | How multiple search clauses should be combined. |
| search_equals | object | optional | A map from Formsite item or meta field IDs to search values, encoded as search_… |
| search_contains | object | optional | A map from Formsite item or meta field IDs to search values, encoded as search_… |
| search_begins | object | optional | A map from Formsite item or meta field IDs to search values, encoded as search_… |
| search_ends | object | optional | A map from Formsite item or meta field IDs to search values, encoded as search_… |
| userDir | string | required | Path parameter: userDir |
/{userDir}/forms/{form_dir}/webhooks
| Param | Type | Required | Description |
|---|---|---|---|
| form_dir | string | required | The form directory identifier whose webhooks should be listed. |
| user_dir | string | optional | Optional Formsite user directory. When omitted, the connected default userDir i… |
| userDir | string | required | Path parameter: userDir |
/{userDir}/forms/{form_dir}/webhooks
| Param | Type | Required | Description |
|---|---|---|---|
| form_dir | string | required | The form directory identifier whose webhook should be created or updated. |
| user_dir | string | optional | Optional Formsite user directory. When omitted, the connected default userDir i… |
| event | string | required | The event name to subscribe, such as result_completed. |
| url | string | required | The webhook destination URL. |
| handshake_key | string | optional | Optional handshake key to include in deliveries. |
| userDir | string | required | Path parameter: userDir |
/{userDir}/forms/{form_dir}/webhooks
| Param | Type | Required | Description |
|---|---|---|---|
| form_dir | string | required | The form directory identifier whose webhook should be deleted. |
| user_dir | string | optional | Optional Formsite user directory. When omitted, the connected default userDir i… |
| url | string | required | The webhook URL to delete from the form. |
| userDir | string | required | Path parameter: userDir |