Resources

Tenancies

Coming soon

Leases, the people on them, rent changes and deposits.

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

A unit has at most one current tenancy. Members are leaseholders, occupants or guarantors. Rent changes are dated and kept as history.

GET/tenancies?status=currentComing soon

List tenancies

Request

curl "https://api.propvara.com/v1/tenancies?status=current" \
  -H "Authorization: Bearer pv_test_…"

Response

{
  "object": "list",
  "data": [ {
    "id": "91aa…",
    "object": "tenancy",
    "unit_id": "c03b…",
    "status": "current",
    "starts_on": "2025-07-01",
    "ends_on": null,
    "rent_cents": 145000,
    "deposit": { "amount_cents": 72500, "filed_on": "2025-07-08", "reference": "RTT-…" },
    "members": [{ "person_id": "5e2f…", "name": "Marie Leblanc", "role": "leaseholder" }]
  } ],
  "has_more": false,
  "next_cursor": null
}

POST/tenancies/{id}/rent-changesComing soon

Record a rent change

Request

curl -X POST "https://api.propvara.com/v1/tenancies/{id}/rent-changes" \
  -H "Authorization: Bearer pv_test_…" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 3f1c…" \
  -d '{ "effective_on": "2027-07-01", "rent_cents": 149000, "note": "Annual increase" }'

Response

{ "object": "rent_change", "effective_on": "2027-07-01", "rent_cents": 149000 }

Previous: Properties & units Next: Charges, payments & expenses