tenants.
tenants doesn’t yet fully follow the response shape
conventions — the numbered phone_1/phone_2/phone_3
columns haven’t been collapsed into an array. Documented here anyway since the rest of the
table is stable; treat those three fields as likely to change shape in a future revision.tenants
GET /v1/stakeholder/tenants — tenant master data and current lease terms.
string
required
Unique property identifier. A string here, where the unversioned equivalent
(
Stakeholder.tenants.property_id) is an integer.string
required
Unique identifier for this tenancy.
integer
Unit the tenant occupies. References
Property.property_structure.string
required
Tenant identifier.
string
Full tenant name as a single field. No separate first/last name available.
string
First name line on the tenant record. Relationship to
person_name isn’t confirmed with
the source system.string
Second name line on the tenant record, if present.
string
Street and house number of the tenant’s contact address.
string
Postal code and city of the tenant’s contact address, combined into one field.
string
Primary contact phone number.
string
Contact email address.
string
Additional phone number.
string
Additional phone number.
string
Additional phone number. These three numbered columns haven’t been collapsed into an
array yet — see the note above.
string
Tenant’s bank account IBAN, if on file.
string
Tenant’s bank name, if on file.
date
Lease start date.
date
Lease end date.
date
Lease end date if an extension option is exercised.
date
Actual/effective lease end date.
date
Deadline to exercise the extension option.
string
Link to the lease document in the document management system, if attached.
The unversioned
Stakeholder.tenants also exposes floor_area_person_id and
property_id_person_id composite keys — neither is present in this v1 response. Join via
property_id and floor_area_id instead.