---
title: "GET /inventory"
method: GET
path: "/inventory"
tags: ["Inventory"]
---

# GET /inventory

`GET /inventory`

## Request

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

## Query parameters

- `nextToken` string
- `maxResults` integer
- `address` string
- `category` 'Unspecified' | 'Residential' | 'Commercial'
- `recordType` 'Unspecified' | 'Sale' | 'Rent'
- `archived` boolean

## Headers

- `AgencyRef` string, required

## Response `200`

OK

- AltoInventoryApiModelsResponsesInventoryPagedResults
  - `meta` AltoInventoryApiModelsResponsesMeta
    - `nextToken` string, nullable
    - `previousToken` string, nullable
  - `items` AltoInventoryApiModelsResponsesInventoryItem[], nullable
    - `id` string, nullable
    - `address` AltoInventoryApiModelsResponsesAddress
      - `subDwelling` string, nullable
      - `nameNo` string, nullable
      - `street` string, nullable
      - `locality` string, nullable
      - `town` string, nullable
      - `county` string, nullable
      - `postcode` string, nullable
      - `countryCode` 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)