Developer Documentation
Platform Overview
Authentication
API Services
Overview Accounts Accounts: Associations Accounts: Metadata Accounts: Profile Appstore: Users Broker Distributions Broker Tours Consumers Consumers: Linked Agents Contacts Contacts: Activity Contacts: Export Contacts: Tags Contacts: Portal Accounts Developers: Identities Developers: Keys Developers: Authorizations Developers: Billing Summary Developers: Change History Developers: Domains Developers: News Feed Webhooks Developers: Roles Developers: Syndications Developers: Templates Developers: Usage Detail Developers: Usage Summary Devices Flexmls: Email Links Flexmls: Listing Meta Origins Flexmls: Listing Meta Translations Flexmls: Listing Meta Field List Translations Flexmls: Listing Reports Flexmls: Listing Updates IDX IDX Links Listing Carts Listing Carts: Portal/VOW Carts Incomplete Listings Incomplete Listings: Documents Incomplete Listings: Documents Metadata Incomplete Listings: Document Uploads Incomplete Listings: FloPlans Incomplete Listings: Photos Incomplete Listings: Photos Metadata Incomplete Listings: Photo Uploads Incomplete Listings: Rooms Incomplete Listings: Tickets Incomplete Listings: Units Incomplete Listings: Videos Incomplete Listings: Videos Metadata Incomplete Listings: Virtual Tours Incomplete Listings: Virtual Tours Metadata Listings Listings: Clusters Listings: Documents Listings: Documents Metadata Listings: FloPlans Listings: Historical Listings: History Listings: Hot Sheet Parameters Listings: Notes Listings: Search Parameters Listings: Open Houses Listings: Photos Listings: Photos Metadata Listings: Photo Uploads Listings: Document Uploads Listings: Rental Calendar Listings: Rooms Listings: Rules Listings: Tour of Homes Listings: Tickets Listings: Units Listings: Validation Listings: Videos Listings: Videos Metadata Listings: Virtual Tours Listings: Virtual Tours Metadata Listing Meta: Custom Fields Listing Meta: Custom Field Groups Listing Meta: Field Order Listing Meta: Field Relations Listing Meta: Property Types Listing Meta: Rooms Listing Meta: Standard Fields Listing Meta: Units Registered Listings Market Statistics Messages News Feed News Feed: Curation News Feed: Events News Feed: Groups News Feed: Metadata News Feed: Restrictions News Feed: Schedule News Feed: Settings News Feed: Templates Notifications Open Houses Portals Portal Groups Portal Groups: Current Portal Groups: Tags Portals: Listing Categories Portals: Metadata Preferences Properties Properties: Clusters Properties Meta: Standard Fields Saved Searches Saved Searches: Provided Saved Searches: Restrictions Saved Searches: Tags Search Templates: Quick Searches Search Templates: Views Search Templates: Sorts Shared Links System Info System Info: Languages System Info: Search Templates
API Explorer
Supporting Documentation
Examples
RESO Web API
RETS
Terms of Use

Listings: Listing Notes

The Listing Notes sub-service allows agents and contacts to share notes about a listing with one another.

  1. Supported Roles
  2. Available Services
    1. Listing Notes
    2. Listing Notes For All Contacts
    3. Listing Note For Specified Contact
  3. Response Description
  4. Expansions
  5. API Explorer
 

Supported Roles

Role Reads Writes Notes
IDX Yes No
Public Yes No
VOW Yes Yes
Portal Yes Yes
Private Yes Yes

More information about roles may be found here.

 

Available Services

Listing Notes

/<API Version>/listings/<Listing.Id>/shared/notes

Note: this service is available only under a VOW/Portal session.

HTTP Method Description Notes
GET Retrieve agent/contact shared notes for a specified listing.
POST Returns HTTP 405 (Method Not Allowed) Not implemented
PUT Replace an existing shared note.
DELETE Deletes an existing shared note.

GET Request

Parameters:

 

GET Response

Example:

{
    "D": {
        "Success": true,
        "Results": [
            {
                "ResourceUri": "/v1/listings/20100815153524571646000000/shared/notes/contacts/20100912536192756362000000",
                "ContactId": "20100912536192756362000000",
                "Note": "Great home, wondering if seller is willing to include hot tub."
            }
        ]
    }
}
 

PUT Request

Request body:

{
    "D": {
        "Note": "Great home, wondering if seller is willing to include hot tub and washer/dryer."
    }
}

PUT Response

The standard success/fail response is returned.

DELETE Request

Parameters:

 

DELETE Response

The standard success/fail response is returned.

Listing Notes For All Contacts

/<API Version>/listings/<Listing.Id>/shared/notes/contacts

Note: this service is available only under a Private session.

HTTP Method Description Notes
GET Retrieve agent/contact shared notes for all contacts regarding a specified listing.
POST Returns HTTP 405 (Method Not Allowed) Not implemented
PUT Returns HTTP 405 (Method Not Allowed) Not implemented
DELETE Returns HTTP 405 (Method Not Allowed) Not implemented

GET Request

Parameters:

 

GET Response

The GET response is identical to the GET response above.

Listing Note For Specified Contact

/<API Version>/listings/<Listing.Id>/shared/notes/contacts/<Contact.Id>

Note: this service is available only under a Private session.

HTTP Method Description Notes
GET Retrieve agent/contact shared notes for a specified listing and contact.
POST Returns HTTP 405 (Method Not Allowed) Not implemented
PUT Replace an existing shared note for a specified contact.
DELETE Deletes an existing shared note for a specified contact.

GET Request

Parameters:

 

GET Response

The GET response is identical to the GET response above.

PUT Request

The PUT body is identical to the PUT body above.

PUT Response

The standard success/fail response is returned.

DELETE Request

Parameters:

 

DELETE Response

The standard success/fail response is returned.

 

Listing Note Description

Attribute Data Type Writeable Required Description
ResourceUri Character No No The resource URI to the note.
ContactId Character No No The Id of the Contact the note is for.
Note Character Yes Yes The listing note text.
 

Expansions

None.

 

API Explorer

The API Explorer does not currently support this service.