Docs
V1 APIConnections

List unit types

Floor plans grouped by bedroom count, with square-footage and pricing ranges rolled up. The usual source for a "1 / 2 / 3 bedroom" summary. 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}/unit-types

Floor plans grouped by bedroom count, with square-footage and pricing ranges rolled up. The usual source for a "1 / 2 / 3 bedroom" summary. 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/unit-types"
{  "data": [    {      "unitTypeName": "string",      "unitTypeSlug": "string",      "bedrooms": 0,      "minSquareFeet": 0,      "maxSquareFeet": 0,      "minPriceAvailable": 0,      "maxPriceAvailable": 0,      "minBaseRent": 0,      "maxBaseRent": 0,      "minTmlp": 0,      "maxTmlp": 0,      "fees": [        {          "fee_id": "6a6e29c0-8cb8-4e1c-8beb-6b16e737bdd5",          "code": "string",          "name": "string",          "description": "string",          "class": "string",          "calculated_amount": 0,          "is_variable": true,          "currency": "USD",          "frequency": "string",          "requirement": "string"        }      ],      "feeTotal": 0,      "feeTotalMax": 0,      "totalUnits": 0,      "availableUnits": 0    }  ]}

List units GET

Every unit on the property, denormalized with building and floor-plan context and a per-fee pricing breakdown. Filter before display: a unit is publicly marketable only when `unitAvailable` is true and `unitModel` and `unitGuestSuite` are false. 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 website configuration GET

Website 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.