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: 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: Shapes 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
Examples
RESO Web API
RETS
FloPlan
Terms of Use

Search Templates: Quick Searches

Quick search templates are user-defined field layouts for user interfaces. They present standard and custom fields the user expects to see in the order the user expects to see them.

 
  1. Supported Roles
  2. Available Services
    1. All Quick Searches
    2. Individual Quick Search
    3. Default Quick Search
    4. Global Default Quick Search
  3. Quick Searches Description
  4. Expansions
 

Supported Roles

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

More information about roles may be found here.

 

Available Services

All Quick Searches

/<API Version>/searchtemplates/quicksearches

All quick searches belonging to or inheritable by the current user.

HTTP Method Description Conditional Notes
GET Returns all quick searches the user has access to, ordered by name. 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

Parameters:

 

GET Response

{
    "D": {
        "Results": [
            {
                "ResourceUri": "/v1/searchtemplates/quicksearches/20120717212004874996000000",
                "Id": "20130717212004874996000000",
                "Name": "My Quick Search",
                "OwnerId": "20000426173054342350000000",
                "MlsId": "20000426143505724628000000",
                "Inheritable": true,
                "Inherited": false,
                "ViewId": "20130717211827902622000000",
                "PropertyTypes": [
                    "A"
                ],
                "Fields": [
                    {
                        "Domain": "StandardFields",
                        "GroupField": null,
                        "Field": "ListPrice"
                    },
                    {
                        "Domain": "CustomFields",
                        "GroupField": "Amenities",
                        "Field": "# Ceiling Fans"
                    }
                ],
                "SavedSearch": null,
                "ModificationTimestamp": "2013-07-09T15:31:47Z"
            }
        ],
        "Success": true
    }
}
 
 

Individual Quick Search

/<API Version>/searchtemplates/quicksearches/<Id>

HTTP Method Description Conditional Notes
GET Returns a specified quick search. 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

Parameters:

Parameter Required Notes
Standard expansion parameters No
 
 

GET Response

See the GET request section for for the quick searches service.

 

Default Quick Search

/<API Version>/searchtemplates/quicksearches/default

When there is no human-entered search template specified as the default, a system-generated template will be provided. This template will not include data for fields such as Name or DisplayName, but will include a list of PropertyTypes and Fields.

HTTP Method Description Conditional Notes
GET Returns the default quick search for the current user 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

Parameters:

Parameter Required Notes
Standard expansion parameters No
 
 

GET Response

See the GET request section for for the quick searches service.

 

Quick Searches Description

Attribute Data Type Description
ResourceUri Character The resource URI to a particular quick search.
Id Character The unique id for the quick search template.
Name Character The user specified name for the quick search template.
OwnerId Character The account Id for the user that created the template.
MlsId Character The account Id for the MLS the owner belongs to.
Inheritable Boolean If true, the quick search template can be inherited by users under the current user's control.
Inherited Boolean If true, the quick search template was inherited from another user.
ViewId Character The associated view record.
PropertyTypes Character List An array of property types the quick search can be used under.
SavedSearch JSON Object If present, the saved search data whose filter should populate the search template.
Fields Expansion A list of standard or custom fields used by the template.
Fields[n].Domain Character The type of listing field. Either StandardFields or CustomFields.
Fields[n].GroupField Character The CustomField group the Field resides under. null if Domain is StandardFields.
Fields[n].Field Character The standard or custom field.
 

Expansions

Expansion Roles Single Record Only? Selection Support? Description
DisplayName All Yes No For non-private roles, if a quick search is associated with an IDX link, the name of that link will provided as the display name.
Fields All Yes No A list of fields associated with the search template.