Leases
Retrieve a lease
Leases
Retrieve a lease
GET
/
leases
/
{leaseId}
Params
leaseId
string
requiredLease id
Response
id
string
The unique identifier for the lease
tenancyId
string
The identifier for the tenancy associated with the lease
operationalState
string
The operational state of the lease (e.g., “Draft”)
contractPeriodState
string
The state of the contract period (e.g., “Active”)
primaryTenantContactName
string
The name of the primary tenant contact
tenantIds
Array of string
The identifiers for the tenants
associatedContactIds
Array of string
The identifiers for the associated contacts
primaryTenantId
string
The identifier for the primary tenant
billingContactId
string
The identifier for the billing contact
balance
Amount Object
The balance details for the lease
depositBalance
Amount Object
The deposit balance details for the lease
prepaidBalance
Amount Object
The prepaid balance details for the lease
contractStart
date
The start date of the contract in ISO 8601 format
contractEnd
date
The end date of the contract in ISO 8601 format
purpose
string
The purpose of the lease (e.g., “key:residential”)
monthlyRentLevel
Amount Object
The monthly rent level details for the lease
archivedAt
date
The date-time in ISO 8601 format of archiving the lease