---
updatedAt: 2026-06-10T13:33:09.000Z
agentTools:
  projectIndex: https://developer.realestateapi.com/llms.txt
---

# Retrieve a Saved Search

### Sample Request

```json
{
	"search_id": "3b17feae-0245-45ef-a91b-77b89ced524c"
}
```

<br />

### Sample Response

```json
{
  "input": {
    "search_id": "3b17feae-0245-45ef-a91b-77b89ced524c"
  },
  "data": {
    "search": {
      "searchId": "3b17feae-0245-45ef-a91b-77b89ced524c",
      "accountId": 59,
      "xUserId": null,
      "searchName": "MLS Active In The 918",
      "searchQuery": "{\"city\":\"Tulsa\",\"state\":\"OK\",\"mls_active\":true}",
      "list_size": 10000,
      "lastReportDate": "2024-05-24T03:28:16.000Z",
      "nextReportDate": "2024-05-25T03:28:16.000Z",
      "createdAt": "2024-05-24T03:25:11.000Z",
      "meta_data": {}
    },
    "results": [
      {
        "id": "186925006",
        "changeType": "deleted",
        "lastUpdateDate": "2024-01-09T00:00:00.000Z"
      },
      {
        "id": "385788",
        "changeType": null,
        "lastUpdateDate": "2024-02-23T00:00:00.000Z"
      },
      {
        "id": "197384549",
        "changeType": "updated",
        "lastUpdateDate": "2024-05-02T00:00:00.000Z"
      },
      {
        "id": "194078780",
        "changeType": "added",
        "lastUpdateDate": "2024-01-09T00:00:00.000Z"
      }
     
    ],
    "summary": {
      "size": 10000,
      "added": 1,
      "deleted": 1,
      "updated": 11,
      "unchanged": 9987
    }
  },
  "statusCode": 200,
  "statusMessage": "Success",
  "credits": 0,
  "live": true,
  "requestExecutionTimeMS": "249ms"
}
```

## What to do with Response from Retrieve API call

* sort each object in the "results" array by "changeType"
* For additions ('added' changeType), make sure to persist this ID to your DB (along with lastUpdateDate) and make the Property Detail API call for additional info since you this is a new record that hasn't been pulled yet
* For updates ('updated' changeType), make a Property Detail call to refresh the record if the timestamp is within your desired refresh period (more than a week old, more than a month old, etc.)
* For deletions ('deleted' changeType), delete this ID from your DB so that you are no longer checking for updates on this ID for the given saved search

## Example "summary" object after Create API call

* for a given zip code with 3431 properties

```json
{
  "summary": {
    "size": 3431,
    "added": 3431,
    "deleted": 0,
    "updated": 0
  }
}
```

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "property-portfolio-apis",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.realestateapi.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "x-api-key"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/v1/PropertyPortfolio/SavedSearch": {
      "post": {
        "summary": "Retrieve a Saved Search",
        "description": "",
        "operationId": "retrieve-a-saved-search",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "search_id": {
                    "type": "string",
                    "description": "Search ID that was returned when the search was saved"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        }
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```