GET
/
leases
curl --request GET \
  --url https://api.helloproper.com/leases \
  --header 'Authorization: <api-key>'
{
  "leases": [
    {
      "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>"
    }
  ]
}

Request

This request supports pagination.

Response

leases
array