v1
latestSwagger 2.02026-07-14453366.1 KBLettingsController
Search all properties available for rent given a range of search criteria and dates.
get/v2/tier2/{shortName}/lettings/advertisedbetweendates
Path parameters
shortNamestring required
The unique client short-name
Query parameters
branchIDstring required
The unique ID of the Branch
offsetinteger required
The index of the first item to return
countinteger required
The maximum number of items to return (up to 1000 per request)
rangeStartDatestring date-time required
The date to search from
rangeEndDatestring date-time required
The date to search to
areaIDstring
The unique ID of the Area
rentMinimumnumber double
The minimum advertised rent to search for
rentMaximumnumber double
The maximum advertised rent to search for
maximumTenantsinteger
The maximum number of tenants a property can accommodate
wantSharedPropertiesboolean
Search for shared properties?
wantStudentPropertiesboolean
Search for student properties?
Response
OK