GET
/
tenancies
curl --request GET \
  --url https://api.helloproper.com/tenancies \
  --header 'Authorization: <api-key>'
{
  "tenancies": [
    {
      "id": "<string>",
      "address": {
        "street": "<string>",
        "streetName": "<string>",
        "streetNumber": "<string>",
        "floor": "<string>",
        "door": "<string>",
        "subdivision": "<string>",
        "postalCode": "<string>",
        "city": "<string>",
        "country": "<string>"
      },
      "groupId": {},
      "currentLease": {
        "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>"
      },
      "leaseIds": [
        {}
      ],
      "unitType": "<string>",
      "unitTypeName": "<string>",
      "roomCounts": [
        {
          "type": "<string>",
          "count": 123
        }
      ],
      "totalArea": {
        "value": 123,
        "unit": "<string>"
      },
      "businessArea": {
        "value": 123,
        "unit": "<string>"
      },
      "archivedAt": "<string>"
    }
  ]
}

Request

This request supports pagination.

Response

tenancies
array