Owners
Get Owners
Required scope: alto/read:contacts. See glossary for definition of <a href="https://developers.vebraalto.com/guides/glossary">Owner</a>.
get/owners
Request
- Base URL: https://api.alto.zoopladev.co.uk
- URL: https://api.alto.zoopladev.co.uk/owners
- Auth: appAuth (a scheme the document does not define)
Query parameters
activeboolean
Filter only active or non-active owners.
property-idstring[]
Only return owners where the propertyId matches one of the values provided
contact-idstring[]
Only return owners where the contactId matches one of the values provided
next-tokenstring
The token for the next page of results.
max-resultsinteger
The maximum number of results to return. The default value is 50, and the maximum value is 250
created-fromstring date-time
The start date for by created date.
created-tostring date-time
The end date for by created date.
modified-fromstring date-time
The start date for by modified date.
modified-tostring date-time
The end date for by modified date.
Headers
AgencyRefstring required
Response
Owners matching the query returned.
Changes
No recorded changes to this operation across all 1 revision of this API.