Docs
V1 APIConnections

Get widget configuration

Embeddable widget configuration for the property. Scoped to the portfolio: `{property}` is a slug resolved against the properties attached to `{connection}`, so a slug outside this portfolio is a `404` rather than another site's property.

Deprecated

GET/api/v1/connection/{connection}/property/{property}/widget

Embeddable widget configuration for the property. Scoped to the portfolio: {property} is a slug resolved against the properties attached to {connection}, so a slug outside this portfolio is a 404 rather than another site's property.

Path Parameters

connection*string

Connection UUID.

Formatuuid
property*string

Property slug, resolved against the properties attached to {connection}. A slug outside that portfolio is a 404. Slug only — a UUID does not resolve here.

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v1/connection/497f6eca-6276-4993-bfeb-53cbbbba6f08/property/1520-gough-street/widget"
{  "active": false,  "campaign": {},  "popups": [    {}  ],  "secondaryForm": [],  "externalFormUrl": "string",  "primaryForm": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "title": "string",    "fields": [      {        "label": "string",        "value": "string",        "selected": true,        "valid": true      }    ],    "integrations": [      {        "name": "string",        "id": 0,        "category": "string",        "supportsLeadCreation": true,        "supportsAppointmentCreation": true      }    ],    "buttonText": "string",    "disclaimer": "string",    "redirect": "string",    "confirmation": "string",    "limitMoveInDate": "string"  },  "info": {},  "leasing": {},  "settings": {},  "scripts": {}}