List Tenancies
Retrieves a paginated list of tenancies, with optional filtering and inclusion of tenant data.
Request
- Base URL: https://api.alto.zoopladev.co.uk
- URL: https://api.alto.zoopladev.co.uk/tenancies
- Auth: appAuth (a scheme the document does not define)
Query parameters
Token used to retrieve the next page of results. This is returned in the response of the previous page.
Maximum number of results to return per page. Defaults to 100 if not specified.
The order of results by tenancy id. Ascending by default. A next-token can only be used with the sort order it was issued for.
Only return tenancies with one of these statuses, by name, comma-separated or repeated. All statuses are returned when not specified.
The start date for filtering tenancies by created date.
The end date for filtering tenancies by created date.
The start date for filtering tenancies by modified date.
The end date for filtering tenancies by modified date.
The start date for filtering tenancies by start date.
The end date for filtering tenancies by start date.
The start date for filtering tenancies by target vacate date.
The end date for filtering tenancies by target vacate date.
The start date for filtering tenancies by first full rent date.
The end date for filtering tenancies by first full rent date.
The start date for filtering tenancies by notice to quit date.
The end date for filtering tenancies by notice to quit date.
The start date for filtering tenancies by end date.
The end date for filtering tenancies by end date.
The start date for filtering tenancies by renewal date.
The end date for filtering tenancies by renewal date.
Controls whether tenants should be included in the response for each tenancy result. By default tenants will not be included.
Headers
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.