Developer Documentation
Platform Overview
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: Mapping Layers Flexmls: Mapping Shapegen 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: Floor Plans Incomplete Listings: FloPlans Incomplete Listings: Photos Incomplete Listings: Photos Metadata Incomplete Listings: Photo Uploads Incomplete Listings: Required Documents 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: Floor Plans 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: Required Documents 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 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 Overlays Overlays: Geometries Portals Portals: Listing Categories Portals: Metadata Preferences 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
Supporting Documentation
Terms of Use

System Info: Search

Provides MLS and user defined settings for default search configuration.

  1. Supported Roles
  2. Available Services
    1. Search Configuration
  3. System Info: Search Description
  4. Expansions

Supported Roles

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

More information about roles may be found here.


Available Services

Search Configuration

/<API Version>/system/search

HTTP Method Description Conditional Notes
GET Returns the MLS and user defined search configuration. No
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Returns HTTP 405 (Method Not Allowed) No Not implemented
DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

GET Request



GET Response

  "D": {
    "Success": true,
    "Results": [{
      "Filters": {
        "MyListings": "StatusChangeDate Ge days(-30) Or StandardStatus Ne 'Canceled','Closed','Expired','Withdrawn'"
      "HotSheet": {
          "Fields": [
                  "Domain": "StandardFields",
                  "GroupField": null,
                  "Field": "City"
      "DefaultMlsStatus": [
      "DefaultMlsId": [
      "MyListingsDefaultMlsStatus": [
      "NewSearchDefaultMlsStatus": [
      "OffMarketListingsRange": {
          "FromQuantity": 30,
          "FromUnit": "days"

System Info: Search Description

Attribute Data Type Description
DefaultMlsStatus Character List A list of MlsStatus values the user has requested by select by default on their search screen. See the MyListingsDefaultMlsStatus and NewSearchDefaultMlsStatus for settings that may override this value for specific workflows.
DefaultMlsId Character List A list of DefaultMlsId values the user has requested to be selected by default on their search screen.
MyListingsDefaultMlsStatus Character List A list of MlsStatus values the user has requested by select by default on their search screen when filtering by the current agent's listings.
NewSearchDefaultMlsStatus Character List A list of MlsStatus values the user has requested by select by default on their search screen when starting a new search from scratch.
Filters.MyListings Character The _filter the user has requested UIs use when viewing their own listings. Should be used in conjunction with the my listings service.
HotSheet.Fields Array of JSON Objects A list of standard or custom fields that should be used to further a hot sheet search. See the Quick Searches response description for more information.
OffMarketListingsRange JSON Object Listings that went off market past this time frame are requested to be excluded from the current user's search.
FromQuantity Integer The number of days, months or years back.
FromUnit Character days, months or years.