Docs
Sites APIConversion

List forms

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

GET/api/sites/v1/forms

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

Authorization

websiteToken
AuthorizationBearer <token>

A Sanctum token scoped to one website.

In: header

Query Parameters

property?string

A property slug on this website. Unknown slug is a 404.

key?string

Form keys, comma-separated.

type?string

Value in

  • "contact"
  • "schedule_tour"
sort?string

Sort key, - prefix for descending, comma-separated for several. Allowed keys are listed per endpoint.

page?integer
Range1 <= value
Default1
per_page?integer
Range1 <= value <= 100
Default50

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

application/json

curl -X GET "https://example.com/api/sites/v1/forms"
{  "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": {    "pagination": {      "total": 0,      "page": 0,      "per_page": 0,      "last_page": 0    },    "cache": {      "tags": [        "string"      ],      "ttl": 0    }  }}

Integrations for one property GET

The enabled connections this property's pages render with, and their allow-listed settings. Tag: `integrations:{property_id}`.

One form GET

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}`.