Docs
V1 APIConnections

List forms

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.

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

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.

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/forms"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "type": "string",      "fields": [        {}      ],      "tour_types": [        {}      ],      "settings": {        "disclaimer": "string",        "redirect_url": "string",        "success_message": "string",        "submit_button_label": "string"      },      "elements_key": "string",      "connections": [        {          "connection_id": "d3547de1-d1f2-4344-b4c2-17169b7526f9",          "connection_name": "string"        }      ]    }  ]}

List group sets GET

Account-wide and property-scoped group-set definitions available to the property, including their nested group trees. 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 lead sources GET

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.