Docs
Sites APIIntegrations

Integrations for every property

One block per property on the website. Tag: `integrations:{property_id}`.

GET/api/sites/v1/integrations

One block per property on the website. Tag: integrations:{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.

category?string

One connection category, for example chatbots, accessibility, analytics or tour. Unknown value is a 422.

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

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/integrations"
{  "data": [    {      "property": {        "id": "string",        "slug": "string",        "name": "string"      },      "integrations": [        {          "id": "string",          "type": "string",          "key": "string",          "name": "string",          "category": "string",          "settings": {},          "tour_types": [            {              "type": "string",              "label": "string",              "redirect_url": "string",              "fields": [                {}              ]            }          ]        }      ]    }  ],  "meta": {    "pagination": {      "total": 0,      "page": 0,      "per_page": 0,      "last_page": 0    },    "cache": {      "tags": [        "string"      ],      "ttl": 0    }  }}

Lead sources for one property GET

A property's lead sources, tracking phone numbers and emails, and the rules a site evaluates in the browser to pick a source for a visit. Tag: `lead-sources:{property_id}`.

Integrations for one property GET

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