Developer Documentation
Platform Overview
Spark API FAQ Advantages of Spark/RESO Web APIs Over RETS How to Set Up API Access Which API is Right for You? Flexmls WordPress Plugin and Smartframe
Authentication
Overview OpenID Connect Access Token SAML Supplemental Authentication Services
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: 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: 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 News Feed News Feed: Curation News Feed: Events News Feed: Metadata News Feed: Restrictions News Feed: Schedule News Feed: Settings News Feed: Templates Open Houses Overlays Overlays: Geometries Portals 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
Attribute Selection App Submission Process Error Codes Escaping Parameters Expansions Listing Display Rules Location Proximity RESO Dictionary Versions RESO Web API Replication Roles Spark Replication Spark API Parameters SparkQL Grammar Standard Response Format Timespan Tile Information Service
Examples
Displaying Standard Field Labels Location Searches Making Fast API Requests Searching Listings Setting Up Portal/VOW Accounts
RESO Web API
Overview Request Parameters Lookup Green Verification Media Member Office OpenHouse Power Production Property Room Unit
RETS
Overview Contact RETS Support Help for MLSs Programs & Tools RETS Listing Activity API Troubleshooting Examples: DMQL Examples: HiRes Photos Examples: Photo Downloads Examples: Photo & Doc names Examples: Replicate Examples: Session Examples: Supplements
FloPlan
Overview Spark API RESO Web API RETS Standalone FloPlan API
Terms of Use
MLS Platform License Agreement Developer Agreement and Terms of Use MLS Member Terms of Use Consumer Terms of Use Spark Store Terms of Use Privacy Policy

Saved Searches: Provided

Provided Searches belong to an agent, but are provided to Portal users so they may view the results of the search.

 
  1. Supported Roles
  2. Available Services
    1. All Provided Searches
    2. Individual Provided Search
    3. All Contacts Provided a Search
  3. Provided Search Description
  4. Expansions
 

Supported Roles

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

More information about roles may be found here.

 

Available Services

All Provided Searches

/<API Version>/provided/savedsearches

HTTP Method Description Conditional Notes
GET Returns all provided searches for the current VOW/Portal user No VOW and Portal roles only
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

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

 

Individual Provided Search

/<API Version>/provided/savedsearches/<Id>

HTTP Method Description Conditional Notes
GET Returns an individual provided search No VOW and Portal roles only
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

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

 

/<API Version>/savedsearches/<Id>/contacts

HTTP Method Description Conditional Notes
GET All contacts provided with a given search. See the ContactIds attribute for the Saved Searches service. No Private role only
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

See the GET request section for for the contacts service.

 

Provided Search Description

See the response description for Saved Searches.

 

Expansions

None.