hosting
GET /v1/sites/{siteId}/forms
Get whether a site's own forms are on, and what its form needs.
Authentication
Send an API key as a bearer token. The key must carry the sites.view permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/forms \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
docs/1185. A static site's own <form> posts to submitSiteForm and is e-mailed to a mailbox on the site's own domain. enabled says whether the engine accepts that site's forms; sitekey is the PUBLIC Cloudflare Turnstile sitekey the page's widget carries (empty until forms were first switched on; the secret is never returned); endpoint is the form's action; mailboxes are the addresses a form may send to (active, receiving mailboxes on the site's own domain in the site's own organisation). available is false when there are none. 404 for a site that is not the caller's. Requires sites.view.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
siteId (path) | Uuid | Yes | Site ID (UUIDv7). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
available | boolean | Yes | False when the site's domain has no mailbox to send to. |
enabled | boolean | Yes | — |
sitekey | string | Yes | PUBLIC Turnstile sitekey for the page's widget; empty until first switched on. |
endpoint | string | Yes | The form's action URL (submitSiteForm). |
domain | string | Yes | The site's own domain; the form's _to is a mailbox local part on it. |
mailboxes | string[] | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 429