• Articles
  • Api Documentation
Show / Hide Table of Contents
  • Setting up the API Client
  • Using the API Client
    • Getting started
  • Customers
    • Adding a customer
  • Branch Users
    • Managing branch users
  • List data
    • Getting list data
  • Properties
    • Referring a property
    • Searching for properties
    • Getting property details
  • Property Images
    • Listing property images
    • Adding property images
    • Removing property images
  • Property Notes
    • Listing property notes
  • Viewings
    • Listing property viewings
    • Creating a viewing
    • Rescheduling a viewing
    • Cancelling a viewing
    • Adding viewing feedback

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.
  • BranchId

    • Type: int
    • Description: The Branch Id of the property.
  • Address

    • Type: PropertyAddress
    • Description: Gets or sets the address of the property.
  • LastUpdated

    • Type: DateTimeOffset
    • Description: Gets or sets the last updated date of the property.
  • Status

    • Type: PropertyStatus
    • Description: Gets or sets the property status. .
In This Article
Back to top Generated by DocFX