---
title: "List Tenancies"
method: GET
path: "/tenancies"
tags: ["Tenancies"]
---

# List Tenancies

`GET /tenancies`

## Request

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

Retrieves a paginated list of tenancies, with optional filtering and inclusion of tenant data.

## Query parameters

- `next-token` string
- `max-results` integer
- `sort-order` 'Asc' | 'Desc'
- `status` string[]
- `created-from` string, date-time
- `created-to` string, date-time
- `modified-from` string, date-time
- `modified-to` string, date-time
- `start-date-from` string, date-time
- `start-date-to` string, date-time
- `target-vacate-date-from` string, date-time
- `target-vacate-date-to` string, date-time
- `first-full-rent-date-from` string, date-time
- `first-full-rent-date-to` string, date-time
- `notice-to-quit-date-from` string, date-time
- `notice-to-quit-date-to` string, date-time
- `end-date-from` string, date-time
- `end-date-to` string, date-time
- `renewal-date-from` string, date-time
- `renewal-date-to` string, date-time
- `include-tenants` boolean

## Headers

- `AgencyRef` string, required

## Response `200`

OK

- AltoPropertyManagementApiModelsResponsesPagedResults1AltoPropertyManagementApiModelsResponsesTenancyListItem
  - `meta` AltoPropertyManagementApiModelsResponsesMeta
    - `nextToken` string, nullable
    - `totalItems` integer
  - `items` AltoPropertyManagementApiModelsResponsesTenancyListItem[], nullable
    - `id` integer
    - `groupId` integer
    - `branchId` integer
    - `propertyId` integer
    - `termYears` integer
    - `termMonths` integer
    - `occupantCount` integer
    - `rent` number, double
    - `rentalFrequency` string, nullable
    - `depositRequested` number, double
    - `depositSchemeType` string, nullable
    - `currencyCode` string, nullable
    - `rentalAddress` 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
    - `startDate` string, date-time, nullable
    - `targetVacateDate` string, date-time, nullable
    - `firstFullRentDate` string, date-time, nullable
    - `noticeToQuitDate` string, date-time, nullable
    - `endDate` string, date-time, nullable
    - `renewalDate` string, date-time, nullable
    - `status` string, nullable
    - `nextTermTenancyId` integer
    - `createdDate` string, date-time, nullable
    - `modifiedDate` string, date-time, nullable
    - `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
    - `links` AltoApiMaterialHateoasLink[], nullable
      - `href` string, nullable
      - `rel` string, nullable

## Other responses

- `400`: Bad Request

---

[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)