Documents

Get documents by PropertyId.

Returns a paginated list of documents for the given 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)

Path parameters

inventoryIdinteger required

The PropertyId to filter documents

Query parameters

typeMediaType[]

Type of file to filter the results by. E.g. File, Image

fileTypeFileType[]

Filter results for a specific file type. E.g. PDF, JPG

nextTokenstring

Token to get next set of results

maxResultsinteger

Number of maximum items to be returned

Headers

AgencyRefstring required

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

Response

Success

Changes

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