get_form_share_info
Read-only
Retrieve a form's complete sharing kit: public answer links, custom domain status, embed snippets, and delivery settings. Check if the form will accept responses before sharing.
Instructions
Everything needed to put a form of the current team in front of an audience: the public answer link (also per language version), the team's custom domain and whether it is actually serving, ready-to-paste embed snippets in three modes (inline / popup / iframe), and the current delivery settings so you can tell whether the form will even accept responses. Pass utmSource to get every link and snippet tagged for one channel. Use this to answer "give me the link / the embed code" and to sanity-check a launch; change the switches with update_form_settings.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| formId | Yes | The form UUID | |
| utmSource | No | Optional channel tag applied to the links and snippets (letters, digits, _ and - only, max 64). Omitted or invalid = no tag, in which case the embed script forwards whatever utm_* the host page already has. | |
| iframeHeight | No | Optional pixel height for the iframe snippet, default 600 | |
| popupButtonText | No | Optional label for the popup-mode button; empty uses the built-in default |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| slug | No | Custom path under the custom domain; only shapes shareUrl while that domain is serving | |
| embed | No | Copy-paste embed snippets { inline, popup, iframe }; null when the form has no public token | |
| title | No | Form title | |
| formId | No | The form | |
| delivery | No | Delivery state: { isActive, submissionAccess, reportGateRequireCode, timeLimit, sharing, answerSheet, booking, gaTrackingId, sharedWithAll }; get_form_share_info adds the team-level examineeSignupDisabled (respondent self-signup off = a login-gated quiz turns away anyone not on the roster) | |
| shareUrl | No | The link to hand out (custom domain when one is serving) | |
| publicToken | No | Token behind the public answer link | |
| customDomain | No | Custom-domain state { domain, status, serving, plan } | |
| languageUrls | No | One link per language version | |
| defaultShareUrl | No | The same quiz on the default domain — always works |