Inventory

Search inventory items

Get a paginated list of inventory items by searching property

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)

Query parameters

querystring required

The query term to filter inventory items. Based on specific fields such as address, postcode, contact name, etc.

archivedboolean

The archived status to search inventory items.

recordType'Unspecified' | 'Sale' | 'Rent'

The record type to search inventory items.

next-tokenstring

The token for the next page of results.

max-resultsinteger

The maximum number of results to return. The maximum number of results to return. The default value is 50, and the maximum value is 250.

branchIdsstring[]

The list of branch unique identifiers for filtering inventory items.

created-fromstring date-time

The start date for filtering inventory items by created date.

created-tostring date-time

The end date for filtering inventory items by created date.

modified-fromstring date-time

The start date for filtering inventory items by modified date.

modified-tostring date-time

The end date for filtering inventory items by modified date.

Headers

AgencyRefstring required

A GUID required in the header of all API requests that grants access to an agent's data

Response

Returns the paginated list of searched inventory items

Changes

No recorded changes to this operation across all 1 revision of this API.