• 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

Listing property notes

In order to list the notes for a property, you'll need to use the PropertyNotes.GetPropertyNotesAsync method on the API client:

var notes = await client.PropertyNotes.GetPropertyNotesAsync(12345);

The above example will return the notes for 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 readonly list of PropertyNoteDetails, and will contain the following properties:

  • Id

    • Type: int
    • Description: Gets or sets the ID of the property note.
  • PropertyId

    • Type: int
    • Description: Gets or sets the ID of the property associated with the note.
  • Type

    • Type: string
    • Description: Gets or sets the type of the note.
  • Note

    • Type: string?
    • Description: Gets or sets the content of the note.
  • CreatedOn

    • Type: DateTimeOffset
    • Description: Gets or sets the date and time when the note was created.
  • CreatedBy

    • Type: string
    • Description: Gets or sets the name of the user who created the note.
  • ShowNoteToVendor

    • Type: bool
    • Description: Gets or sets a value indicating whether the note should be shown to the vendor.
  • ShowNoteToApplicant

    • Type: bool
    • Description: Gets or sets a value indicating whether the note should be shown to the applicant.
In This Article
Back to top Generated by DocFX