Docs
V1 APIConnections

List lead sources

Lead sources configured on the property. Use a source's `code` as `resi_source_key` when submitting leads so your traffic is attributed. 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.

GET/api/v1/connection/{connection}/property/{property}/lead-sources

Lead sources configured on the property. Use a source's code as resi_source_key when submitting leads so your traffic is attributed. 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/lead-sources"
{  "propertyId": "8e8b8450-dc1b-4360-8109-7067337b42cb",  "fallbackPhone": "string",  "fallbackEmail": "string",  "externalSourceField": "string",  "sources": [    {      "id": 0,      "property_id": "05003a8a-8f3c-454b-8884-a906ec46f5f5",      "name": "string",      "code": "string",      "external_source_key": "string",      "source": "string",      "phone": "string",      "email": "string"    }  ],  "resolution": {    "sourceObservationEndpoint": "string",    "clickIdParams": [      "gclid"    ],    "rules": [      {        "id": 0,        "type": "string",        "parameter": "string",        "pattern": "string",        "value": "string",        "condition_operator": "all",        "conditions": [          {            "type": "string",            "parameter": "string",            "pattern": "string",            "value": "string"          }        ],        "priority": 0,        "lead_source_id": 0,        "source": "string",        "external_source_key": "string",        "phone": "string"      }    ]  }}

List forms GET

Enabled forms for the property, with field definitions and the CRM destinations each routes to. Discover the `form_id` here rather than hardcoding it, and re-fetch when lead submission returns a `404`, which means the form no longer exists. A `422` is about the submitted values (email, `form_id`, dates), not the form. 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.

List integrations GET

Connections attached to the property, with secrets stripped. Tour-capable entries carry the `id` you pass as `connection_id` to the tour endpoints. 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.