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

# Search inventory items

`GET /inventory/search`

## Request

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

Get a paginated list of inventory items by searching property

## Query parameters

- `query` string, required
- `archived` boolean
- `recordType` 'Unspecified' | 'Sale' | 'Rent'
- `next-token` string
- `max-results` integer
- `branchIds` string[]
- `created-from` string, date-time
- `created-to` string, date-time
- `modified-from` string, date-time
- `modified-to` string, date-time

## Headers

- `AgencyRef` string, required

## Response `200`

Returns the paginated list of searched inventory items

- AltoInventoryApiModelsResponsesSearchInventorySearchResults
  - `meta` AltoInventoryApiModelsResponsesSearchMeta
    - `nextToken` string, nullable
  - `items` AltoInventoryApiModelsResponsesSearchInventoryItem[], nullable
    - `inventoryId` string, nullable: The ID of the inventory record.
    - `branchId` string, nullable: The ID of the branch.
    - `createdAt` string, date-time, nullable: The date and time the inventory record was created.
    - `modifiedAt` string, date-time, nullable: The date and time the inventory record was last modified.
    - `categoryType` 'Unspecified' | 'Residential' | 'Commercial'
    - `recordType` 'Unspecified' | 'Sale' | 'Rent'
    - `archived` boolean: boolean value indicating whether inventory record has been archived
    - `status` 'Unspecified' | 'Appraisal' | 'Available' | 'UnderOffer' | 'Completed' | 'Let' | 'LetAgreed' | 'LetMarketing' | 'Archived' | 'Suspended' | 'Withdrawn' | 'Instructed' | 'NotInstructed' | 'ExternallyLet' | 'UnderOfferMarketing' | 'UnderOfferAvailable' | 'Exchanged' | 'ExternallySold' | 'Reserved'
    - `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
    - `managementType` 'Unspecified' | 'NotManaged' | 'PartManaged' | 'Managed' | 'FullyManaged' | 'RentCollectionService' | 'LetOnly'
    - `maintenanceType` 'Unspecified' | 'MaintainedByLandlord' | 'MaintainedByUs'
    - `instructionDate` string, date-time, nullable: The date and time the inventory record was instructed.

## Other responses

- `400`: When the request does not contain the expected information
- `401`: When access has not been granted

---

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