Saved Searches

This documentation has moved to the Spark Platform website. Please click here to view.

The Saved Searches service allows retrieval of a list of saved searches for the current user.

  1. Applicable API Key Roles
  2. Authentication
  3. Available Services
    1. Saved Searches
    2. Individual Saved Searches

Applicable API Key Roles

This service is available to API keys with IDX roles with both IDX and portal permissions. More information about roles may be found here.

Authentication

Requests must be authenticated according to these instructions or HTTP 401 (Unauthorized) will be returned.

Available Services

Saved Searches

URI: /<API Version>/savedsearches/

HTTP Method Description
GET Returns a list of saved searches for the current user. Results are paginated with the standard search and paging syntax.
POST, PUT, DELETE Returns HTTP 405 (Method Not Allowed). These methods are not implemented.

GET Response

Here’s an example response:

{
    "D": {
        "Success": true,
        "Results": [
            { 
              "ResourceUri": "/vX/savedsearches/20100815220615294367000000",
              "Id":  "20100815220615294367000000",
              "Name": "Search name here" 
            },
            { 
              "ResourceUri": "/vX/savedsearches/20100615220615292711000000",
              "Id":  "20100615220615292711000000",
              "Name": "Second search name here" 
            }
        ]
    }
}

Individual Saved Searches

URI: /<API Version>/savedsearches/XX

XX represents a saved search ID obtained from the Saved Searches service above.

HTTP Method Description
GET Returns information about a specific saved search.
POST, PUT, DELETE Returns HTTP 405 (Method Not Allowed). These methods are not implemented.

GET Response

The response is the same as the GET response format above, except that only one saved search will be returned.

Comments on this entry are closed.