Landlords
List Landlords
Retrieves a paginated list of landlord contacts with optional filtering.
get/landlords
Request
- Base URL: https://api.alto.zoopladev.co.uk
- URL: https://api.alto.zoopladev.co.uk/landlords
- Auth: appAuth (a scheme the document does not define)
Query parameters
next-tokenstring
Token used to retrieve the next page of results. This is returned in the response of the previous page.
max-resultsinteger
Maximum number of results to return per page. Defaults to 100 if not specified.
created-fromstring date-time
The start date for filtering landlords by created date.
created-tostring date-time
The end date for filtering landlords by created date.
modified-fromstring date-time
The start date for filtering landlords by modified date.
modified-tostring date-time
The end date for filtering landlords by modified date.
active-status'Active' | 'Archived' | 'All'
Optionally filter landlords by their active status. By default only active landlords will be returned.
Headers
AgencyRefstring required
A GUID required in the header of all API requests that grants access to an agent's data
Response
OK
Changes
No recorded changes to this operation across all 1 revision of this API.