GET
/
leases
/
{leaseId}
Retrieve a lease
curl --request GET \
  --url https://api.helloproper.com/leases/{leaseId} \
  --header 'Authorization: <api-key>'
{
  "id": "<string>",
  "tenancyId": "<string>",
  "operationalState": "<string>",
  "contractPeriodState": "<string>",
  "primaryTenantContactName": "<string>",
  "tenantIds": {},
  "associatedContactIds": {},
  "primaryTenantId": "<string>",
  "billingContactId": "<string>",
  "balance": {
    "currency": "<string>",
    "amount": 123
  },
  "depositBalance": {
    "currency": "<string>",
    "amount": 123
  },
  "prepaidBalance": {
    "currency": "<string>",
    "amount": 123
  },
  "contractStart": "<string>",
  "contractEnd": "<string>",
  "purpose": "<string>",
  "monthlyRentLevel": {
    "currency": "<string>",
    "amount": 123
  },
  "archivedAt": "<string>"
}

​
Params

​
leaseId
string
required
Lease 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