Docs
Sites APIConversion

One form

A form by id. A form on no property of this website, a disabled form and a malformed id are all a 404. Tags: `forms:{property_id}`.

GET/api/sites/v1/forms/{form}

A form by id. A form on no property of this website, a disabled form and a malformed id are all a 404. Tags: forms:{property_id}.

Authorization

websiteToken
AuthorizationBearer <token>

A Sanctum token scoped to one website.

In: header

Path Parameters

form*string

The form's id.

Header Parameters

X-Resi-Website?string

Website id. Overrides Host resolution for builds running where Host is meaningless. The token must still be scoped to this website.

If-None-Match?string

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/sites/v1/forms/string"
{  "data": {    "id": "string",    "key": "string",    "name": "string",    "type": "string",    "fields": [      {        "key": "string",        "type": "string",        "label": "string",        "placeholder": "string",        "required": true,        "width": "string",        "options": [          "string"        ],        "settings": {}      }    ],    "tour_types": [      {}    ],    "settings": {      "disclaimer": "string",      "redirect_url": "string",      "success_message": "string",      "submit_button_label": "string"    },    "properties": [      {        "id": "string",        "slug": "string",        "name": "string"      }    ],    "submit_path": "string"  },  "meta": {    "cache": {      "tags": [        "string"      ],      "ttl": 0    }  }}

List forms GET

Enabled forms attached to the website's properties. Sort key: `name`. Tags: `forms:{property_id}`.

Submit a form POST

Creates a lead. Call this from the site's own server with the website token; the token must never reach a browser. The lead takes the same path as any other: created and recorded as a demand event before the response; email notifications and the form's CRM connections run just after it, so a slow CRM never holds the form open. Limited to 60 requests a minute per website.