Resources

Properties & units

Coming soon

Buildings, their units and the ownership entity behind them.

Planned API. This page describes the design we're building toward and may change before release. Request early access.

A property belongs to one ownership entity and has one or more units. Your key sees properties your workspace manages under an active management agreement, or that your entity owns.

GET/propertiesComing soon

List properties

Parameter	Description
`entity_id`uuid	Only properties owned by this entity
`province`string	Two-letter code, e.g. NB
`cursor`string	From the previous page

Request

curl "https://api.propvara.com/v1/properties" \
  -H "Authorization: Bearer pv_test_…"

Response

{
  "object": "list",
  "data": [ {
    "id": "2f9c…",
    "object": "property",
    "name": "14 Elm Street",
    "address": { "line1": "14 Elm Street", "city": "Moncton", "province": "NB", "postal_code": "E1C 1A1" },
    "entity_id": "a71d…",
    "rental_mode": "long_term",
    "unit_count": 4,
    "approval_threshold_cents": 50000
  } ],
  "has_more": false,
  "next_cursor": null
}

GET/properties/{id}/unitsComing soon

List a property's units

Request

curl "https://api.propvara.com/v1/properties/{id}/units" \
  -H "Authorization: Bearer pv_test_…"

Response

{
  "object": "list",
  "data": [ {
    "id": "c03b…",
    "object": "unit",
    "label": "2",
    "beds": 2,
    "baths": 1,
    "market_rent_cents": 145000,
    "status": "occupied",
    "vacant_since": null
  } ],
  "has_more": false,
  "next_cursor": null
}

POST/properties/{id}/unitsComing soon

Add a unit

Request

curl -X POST "https://api.propvara.com/v1/properties/{id}/units" \
  -H "Authorization: Bearer pv_test_…" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 3f1c…" \
  -d '{ "label": "5", "beds": 1, "baths": 1, "market_rent_cents": 115000 }'

Response

{ "id": "e1d4…", "object": "unit", "label": "5", "status": "vacant" }

Previous: Calendar feeds (iCal)Next: Tenancies