---
title: "Get documents by PropertyId."
method: GET
path: "/inventory/{inventoryId}/documents"
tags: ["Documents"]
---

# Get documents by PropertyId.

`GET /inventory/{inventoryId}/documents`

## Request

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

Returns a paginated list of documents for the given PropertyId

## Path parameters

- `inventoryId` integer, required

## Query parameters

- `type` MediaType[]
- `fileType` FileType[]
- `nextToken` string
- `maxResults` integer

## Headers

- `AgencyRef` string, required

## Response `200`

Success

- DocumentPagedResults
  - `meta` Meta
    - `nextToken` string, nullable
    - `previousToken` string, nullable
  - `items` Document[], nullable
    - `id` string, nullable: The unique identifier of the document
    - `type` string, nullable: The type of the document e.g. Property, Tenancy, Contact or Work Order
    - `fileName` string, nullable: The file name of the document
    - `fileType` string, nullable: The file type of the document
    - `url` string, nullable: The URL for the document, if applicable
    - `caption` string, nullable: The caption of the document
    - `createdDate` string, date-time, nullable: The date the document was created
    - `modifiedDate` string, date-time, nullable: The date the document was modified

## Other responses

- `400`: Validation errors e.g. The MaxResults must be greater than 0

---

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