---
title: "GET /inventory/{inventoryId}/tenancies"
method: GET
path: "/inventory/{inventoryId}/tenancies"
tags: ["Tenancies"]
---

# GET /inventory/{inventoryId}/tenancies

`GET /inventory/{inventoryId}/tenancies`

## Request

- Base URL: `https://api.alto.zoopladev.co.uk`
- URL: `https://api.alto.zoopladev.co.uk/inventory/{inventoryId}/tenancies`
- Auth: `appAuth` (a scheme the document does not define)

## Path parameters

- `inventoryId` integer, required

## Query parameters

- `nextToken` string
- `maxResults` integer

## Headers

- `AgencyRef` string, required

## Response `200`

OK

- AltoPropertyManagementApiModelsResponsesPagedResults1AltoPropertyManagementApiModelsResponsesTenancy
  - `meta` AltoPropertyManagementApiModelsResponsesMeta
    - `nextToken` string, nullable
    - `totalItems` integer
  - `items` AltoPropertyManagementApiModelsResponsesTenancy[], nullable
    - `id` integer
    - `rent` number, double
    - `currencyCode` string, nullable
    - `rentalFrequency` string, nullable
    - `startDate` string, date-time, nullable
    - `endDate` string, date-time, nullable
    - `targetVacateDate` string, date-time, nullable
    - `status` string, nullable
    - `occupantCount` integer
    - `tenants` AltoPropertyManagementApiModelsResponsesTenant[], nullable
      - `id` string, nullable
      - `title` string, nullable
      - `forename` string, nullable
      - `surname` string, nullable
      - `phone` string, nullable
      - `email` string, nullable
      - `address` AltoPropertyManagementApiModelsResponsesAddress
        - `subDwelling` string, nullable
        - `nameNo` string, nullable
        - `street` string, nullable
        - `locality` string, nullable
        - `town` string, nullable
        - `county` string, nullable
        - `postcode` string, nullable
        - `country` string, nullable
      - `createdDate` string, date-time, nullable
      - `modifiedDate` string, date-time, nullable
      - `links` AltoApiMaterialHateoasLink[], nullable
        - `href` string, nullable
        - `rel` string, nullable

## Other responses

- `400`: Bad Request
- `404`: Not Found

---

[API](https://skmtc.dev/alto/apis/alto-api.md) - [All operations](https://skmtc.dev/alto/apis/alto-api/llms.txt) - [OpenAPI document](https://skmtc.dev/alto/apis/alto-api/revisions/1b729d9b15a8?raw)