Get a form
get_formOne form's settings: fields (every item in order, with its settings, headings, text blocks and page breaks included, in the shape update_form takes back), allowed websites, success message or redirect, anti-spam check, owner alert, Google Sheet link, the form it changes rows of (targetFormId) if any, whether Record Fetch is on, and the revision update_form and set_form_status need. console_only lists what on this form the connector cannot edit (file upload questions, show-if and page-skip rules, uploaded page pictures, a blocked page), each with where in the Webtzm console to change it. share_url is the address of the form's public Webtzm page while that page is on, otherwise null. page is the page's settings: what is set, response_count and closed when a closing date or limit is set, inactive_pro_parts (stored Pro settings this plan ignores), pictures and whether Webtzm has blocked it. Read it before changing a page. A prefilled link is the share_url followed by ?= (repeat a key to tick several boxes); hidden, file upload, consent and grid questions and headings and text blocks are never prefilled, and nothing private belongs in a link.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"form_id": "<form_id>"
},
"name": "get_form"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| form_id | Yes | The form's id, as list_forms returns it. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| name | Yes | ||
| page | No | The form's public Webtzm page: what is set, what it costs to keep, and why it is closed if it is. | |
| sheet | Yes | ||
| fields | Yes | The form's items in order, as create_form and update_form take them: questions with their settings, and headings, text blocks and page breaks between them. | |
| output | Yes | ||
| status | Yes | ||
| revision | Yes | ||
| operation | No | ||
| share_url | No | The form's public page address, a short link that stays the same for good, while the page is on, otherwise null. | |
| ownerAlert | Yes | ||
| recordLinks | No | ||
| allowedSites | Yes | ||
| console_only | No | What is on this form that this connection cannot edit, each with where in the Webtzm console to change it. Empty when there is none. | |
| targetFormId | No | ||
| retentionDays | No | ||
| spamProtection | Yes | ||
| successMessage | Yes | ||
| recordFetchEnabled | No | ||
| successRedirectUrl | Yes |