Searching for properties
In order to search for properties, you'll need to use the Properties.GetPropertiesAsync method on the API client:
var properties = await client.Properties.GetPropertiesAsync(new GetPropertiesRequest{
LastUpdatedFrom = DateTime.UtcNow.AddDays(-7),
LastUpdatedTo = DateTime.UtcNow,
});
The above example will return all properties that have been updated in the last 7 days.
The LastUpdatedFrom and LastUpdatedTo properties are optional, and can be used to filter the results by the date the
property was last updated. If you don't specify these properties, all properties will be returned.
Over time there may be additional filters added to the GetPropertiesRequest object. These will be documented here when they
The response will be a readonly list
of PropertySummary, and will contain the
following properties:
Id
- Type:
int - Description: Gets or sets the ID of the property.
- Type:
BranchId
- Type:
int - Description: The Branch Id of the property.
- Type:
Address
- Type:
PropertyAddress - Description: Gets or sets the address of the property.
- Type:
LastUpdated
- Type:
DateTimeOffset - Description: Gets or sets the last updated date of the property.
- Type:
Status
- Type:
PropertyStatus - Description: Gets or sets the property status. .
- Type: