Docs
V1 APIInventory

List buildings

Buildings on the property, each with a count of its available units.

GET/api/v1/property/{property}/buildings

Buildings on the property, each with a count of its available units.

Path Parameters

property*string

Property UUID. This route is unauthenticated and unscoped, so it does not accept a slug — to address a property by slug, use /api/v1/connection/{connection}/property/{property}.

Formatuuid

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/property/019dbc38-d49e-7310-95d4-711a5b7a4b40/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"          }        }      ]    }  ]}

List unit types GET

Floor plans grouped by bedroom count, with square-footage and pricing ranges rolled up. The usual source for a "1 / 2 / 3 bedroom" summary.

Get a unit's lease-term price matrix GET

Term-by-term pricing for one unit, ordered by lease start date. **Two behaviors to design around.** 1. *Live PMS fallback.* When Resi holds no stored matrix for the unit, it queries the property's PMS connection in real time and normalizes the result. That is materially slower than a database read and depends on the PMS being reachable. Set a generous client timeout; never call this in a loop across a portfolio. 2. *An empty array is a legitimate answer.* No PMS connection, no matrix from the provider, or a unit without term pricing all return `[]`. Fall back to the unit's rent range rather than showing nothing. Call it lazily on unit detail and cache per unit per day.