Docs
V1 APIConnections

List buildings

Buildings on the property, each with a count of its available units. 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}/buildings

Buildings on the property, each with a count of its available units. 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.

Query Parameters

group?string

Group UUID. Matching includes descendants of the selected group.

Formatuuid

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/connection/497f6eca-6276-4993-bfeb-53cbbbba6f08/property/1520-gough-street/buildings"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "buildingNumber": "string",      "buildingCode": "string",      "buildingName": "string",      "buildingType": "string",      "buildingImage": "http://example.com",      "buildingImageFull": "http://example.com",      "unitsAvailable": true,      "numberUnitsAvailable": 0,      "buildingTags": [        "string"      ],      "buildingTagsString": "string",      "groups": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "label": "string",          "slug": "string",          "set": {            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",            "name": "string",            "objectType": "property"          }        }      ]    }  ]}