Documents
Get documents by document type.
Returns a paginated list of documents that match the given parameters
get/documents
Request
- Base URL: https://api.alto.zoopladev.co.uk
- URL: https://api.alto.zoopladev.co.uk/documents
- Auth: appAuth (a scheme the document does not define)
Query parameters
linkedTypestring
linkedIdinteger
Id of the document association e.g. PropertyId, ContactId, TenancyId, WorkOrderId, HistoryEventId (or FileNoteId)
mediaTypestring
Type of document e.g. File, Image
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.