• 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

Getting property details

In order to get the details of a property, you'll need to use the Properties.GetPropertyDetailsAsync method on the API client:

var property = await client.Properties.GetPropertyDetailsAsync(12345);

The above example will return the details of the property with ID 12345.

If the property doesn't exist, or you don't have access to it, a null value will be returned.

The response will be a PropertyDetails object, 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.
  • Price

    • Type: decimal
    • Description: Gets or sets the price of the property.
  • Description

    • Type: string
    • Description: Gets or sets the description of the property.
  • ParkingType

    • Type: ParkingType
    • Description: Gets or sets the parking type of the property.
  • PropertyType

    • Type: ApiPropertyType
    • Description: Gets the property type of the property.
  • Residential

    • Type: ResidentialPropertyDetails?
    • Description: Gets or sets the details specific to a residential property.
  • Commercial

    • Type: CommercialPropertyDetails?
    • Description: Gets or sets the details specific to a commercial property.
  • Auction

    • Type: AuctionDetails?
    • Description: Gets or sets the auction details specific to a property if there are any.
In This Article
Back to top Generated by DocFX