> ## Documentation Index
> Fetch the complete documentation index at: https://docs.helloproper.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve a tenancy

### Params

<ParamField path="tenancyId" type="string" required>
  Tenancy id
</ParamField>

### Response

<ResponseField name="id" type="string">
  The unique identifier for the tenancy
</ResponseField>

<ResponseField name="address" type="object">
  The address details of the tenancy

  <Expandable>
    <ResponseField name="street" type="string">
      The full street name and number
    </ResponseField>

    <ResponseField name="streetName" type="string">
      The name of the street
    </ResponseField>

    <ResponseField name="streetNumber" type="string">
      The number of the property on the street
    </ResponseField>

    <ResponseField name="floor" type="string">
      The floor of the address if applicable
    </ResponseField>

    <ResponseField name="door" type="string">
      The door of the address if applicable
    </ResponseField>

    <ResponseField name="subdivision" type="string">
      The subdivision of the address if applicable
    </ResponseField>

    <ResponseField name="postalCode" type="string">
      The postal code for the address
    </ResponseField>

    <ResponseField name="city" type="string">
      The city of the address
    </ResponseField>

    <ResponseField name="country" type="string">
      The country code of the address
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="groupId" type="object">
  Categories mapped to the corresponding groups
</ResponseField>

<ResponseField name="currentLease" type="object">
  The details of the Current Lease Object for the tenancy

  <Expandable>
    <ResponseField name="id" type="string">
      The unique identifier for the lease
    </ResponseField>

    <ResponseField name="tenancyId" type="string">
      The identifier for the tenancy associated with the lease
    </ResponseField>

    <ResponseField name="operationalState" type="string">
      The operational state of the lease (e.g., "Draft")
    </ResponseField>

    <ResponseField name="contractPeriodState" type="string">
      The state of the contract period (e.g., "Active")
    </ResponseField>

    <ResponseField name="primaryTenantContactName" type="string">
      The name of the primary tenant contact
    </ResponseField>

    <ResponseField name="tenantIds" type="array">
      The identifiers for the tenants
    </ResponseField>

    <ResponseField name="associatedContactIds" type="array">
      The identifiers for the associated contacts
    </ResponseField>

    <ResponseField name="primaryTenantId" type="string">
      The identifier for the primary tenant
    </ResponseField>

    <ResponseField name="billingContactId" type="string">
      The identifier for the billing contact
    </ResponseField>

    <ResponseField name="balance" type="object">
      The balance for the lease

      <Expandable>
        <ResponseField name="currency" type="string">
          The currency code for the balance amount (e.g., "DKK")
        </ResponseField>

        <ResponseField name="amount" type="number">
          The amount of balance amount (e.g., 100.00)
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="depositBalance" type="object">
      The deposit balance for the lease

      <Expandable>
        <ResponseField name="currency" type="string">
          The currency code for the deposit balance amount (e.g., "DKK")
        </ResponseField>

        <ResponseField name="amount" type="number">
          The amount of the prepaid balance amount (e.g., 100.00)
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="prepaidBalance" type="object">
      The prepaid balance for the lease

      <Expandable>
        <ResponseField name="currency" type="string">
          The currency code for the balance amount (e.g., "DKK")
        </ResponseField>

        <ResponseField name="amount" type="number">
          The amount of prepaid balance amount (e.g., 100.00)
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="contractStart" type="date">
      The start date of the contract in ISO 8601 format
    </ResponseField>

    <ResponseField name="contractEnd" type="date">
      The end date of the contract in ISO 8601 format
    </ResponseField>

    <ResponseField name="purpose" type="string">
      The purpose of the lease (e.g., "key:residential")
    </ResponseField>

    <ResponseField name="monthlyRentLevel" type="object">
      The monthly rent level details for the lease

      <Expandable>
        <ResponseField name="currency" type="string">
          The currency code for the monthly rent level (e.g., "DKK")
        </ResponseField>

        <ResponseField name="amount" type="number">
          The amount of the monthly rent level
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="archivedAt" type="date">
      The date-time in ISO 8601 format of archiving the lease
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="leaseIds" type="array">
  The identifiers for all leases associated with the tenancy
</ResponseField>

<ResponseField name="unitType" type="string">
  The type of the unit (e.g., "PARKING")
</ResponseField>

<ResponseField name="unitTypeName" type="string">
  The description of unit type, if unit type is "OTHER"
</ResponseField>

<ResponseField name="roomCounts" type="array">
  <Expandable>
    <ResponseField name="type" type="string">
      The type of the room (e.g., "ROOM")
    </ResponseField>

    <ResponseField name="count" type="integer">
      The count of the room type
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="totalArea" type="object">
  The total area of the tenancy

  <Expandable>
    <ResponseField name="value" type="number">
      The value of the total area
    </ResponseField>

    <ResponseField name="unit" type="string">
      The unit of measurement for the area (e.g., "m²")
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="businessArea" type="object">
  The business area of the tenancy

  <Expandable>
    <ResponseField name="value" type="number">
      The value of the business area
    </ResponseField>

    <ResponseField name="unit" type="string">
      The unit of measurement for the area (e.g., "m²")
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="archivedAt" type="date">
  The date-time in ISO 8601 format of archiving the tenancy
</ResponseField>
