---
updatedAt: 2026-06-02T20:11:26.000Z
agentTools:
projectIndex: https://docs.repliers.io/llms.txt
---
# Create a saved search
Use this endpoint to create a saved search for a client.
Important - the filters must be specific enough so that the initial matches do not exceed 100 listings (the default, which may be configured per account), otherwise a 406 (not accepted) response will be received. A client may have at most 5 saved searches by default (also configurable per account); exceeding that limit returns a 406.
Validation rules
clientId must belong to your account, and agentId (if supplied) must be an agent in your account that the client is assigned to.
cities and areas must match values that exist on listings in your MLS data (case-insensitive).
propertyTypes and styles must be values returned by GET /listings?listings=false&aggregates=details.propertyType,details.style.
For every min/max pair (price, beds, baths, sqft, yearBuilt, stories, coveredSpaces, lotSizeSqft, lotWidth) the minimum cannot be greater than the maximum.
map polygons must contain at least 3 distinct coordinates.
# OpenAPI definition
```json
{
"openapi": "3.1.0",
"info": {
"title": "repliers",
"version": "1.0"
},
"servers": [
{
"url": "https://api.repliers.io"
}
],
"components": {
"securitySchemes": {
"sec0": {
"type": "apiKey",
"in": "header",
"name": "REPLIERS-API-KEY"
}
}
},
"security": [
{
"sec0": []
}
],
"paths": {
"/places": {
"get": {
"summary": "Places",
"description": "Use this endpoint to retrieve relevant schools, parks, transit stops and safety places for a given latitude and longitude. This endpoint is useful to enrich property and neighborhood views with local places information.",
"operationId": "places",
"parameters": [
{
"name": "lat",
"in": "query",
"description": "The latitude of the point that you'd like to retrieve places data for.",
"required": true,
"schema": {
"type": "number",
"format": "float",
"minimum": -90,
"maximum": 90
}
},
{
"name": "long",
"in": "query",
"description": "The longitude of the point that you'd like to retrieve places data for.",
"required": true,
"schema": {
"type": "number",
"format": "float",
"minimum": -180,
"maximum": 180
}
},
{
"name": "inputInsidePolygon",
"in": "query",
"description": "Filters places by whether the specified lat/long falls inside their boundary polygon. Every returned place that has a boundary polygon always includes an `inputInsidePolygon` field with this result, regardless of this parameter. When set to `true`, only places whose polygon contains the point are returned. When set to `false`, only places whose polygon does not contain the point are returned. Places without a boundary polygon are always returned and do not include the field.",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"schools": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/paths/~1places/get/responses/200/content/application~1json/schema/properties/parks/items/allOf/0"
},
{
"type": "object",
"properties": {
"grade_level": {
"type": "string",
"nullable": true
},
"grades_offered": {
"type": "array",
"items": {
"type": "string"
}
},
"additional_details": {
"type": "array",
"items": {}
},
"language": {
"type": "string",
"nullable": true
},
"affiliation": {
"type": "string",
"nullable": true
},
"orientation": {
"type": "string",
"nullable": true
},
"school_board": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
},
"score": {
"nullable": true,
"description": "A school quality/rating score, if available. Exact scale unconfirmed."
},
"has_catchment": {
"type": "boolean",
"nullable": true
},
"special_programs": {
"type": "array",
"items": {}
},
"neighbourhoods_served": {
"type": "array",
"description": "Neighbourhoods within this school's catchment.",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
}
}
}
}
}
}
]
}
},
"parks": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"description": "Fields common to every place category (schools, parks, transit_stops, safety_places).",
"properties": {
"id": {
"type": "string",
"example": "12345",
"description": "The unique identifier of this place."
},
"name": {
"type": "string",
"example": "Lincoln Elementary School",
"description": "The name of this place."
},
"slug": {
"type": "string",
"example": "lincoln-elementary-school",
"description": "A URL-friendly identifier for this place."
},
"full_slug": {
"type": "string",
"example": "tx/houston/lincoln-elementary-school",
"description": "A fully-qualified URL-friendly identifier for this place."
},
"description": {
"type": "string",
"nullable": true,
"description": "A description of this place, if available."
},
"url": {
"type": "string",
"nullable": true,
"example": "https://example.com/resource/123",
"description": "A URL with more information about this place, if available."
},
"features": {
"type": "object",
"description": "A dynamic map of category-specific attributes (e.g. contact info, classification codes). Keys and value types vary by place and category, so they aren't individually enumerated here.",
"additionalProperties": true
},
"country": {
"type": "string",
"nullable": true,
"example": "United States"
},
"state_province": {
"type": "string",
"nullable": true,
"example": "TX"
},
"city": {
"type": "object",
"nullable": true,
"properties": {
"id": {
"type": "string",
"example": "1"
},
"name": {
"type": "string",
"example": "Houston"
},
"slug": {
"type": "string",
"example": "houston"
}
}
},
"county": {
"type": "object",
"nullable": true,
"properties": {
"id": {
"type": "string",
"example": "1"
},
"name": {
"type": "string",
"example": "Harris"
},
"slug": {
"type": "string",
"example": "harris"
}
}
},
"neighbourhood": {
"type": "object",
"nullable": true,
"properties": {
"id": {
"type": "string",
"example": "1"
},
"name": {
"type": "string",
"example": "Lakewood Forest"
},
"slug": {
"type": "string",
"example": "lakewood-forest"
}
}
},
"place_type": {
"type": "string",
"example": "school",
"description": "The category of place (e.g. school, park, transit_stop, safety_place)."
},
"distance": {
"type": "number",
"example": 0.8,
"description": "The distance from the queried lat/long to this place."
},
"point": {
"type": "object",
"description": "The lat/long coordinates of this place.",
"properties": {
"lat": {
"type": "number",
"example": 29.98234
},
"lng": {
"type": "number",
"example": -95.603577
}
}
},
"geometry": {
"type": "object",
"nullable": true,
"description": "A GeoJSON boundary polygon for this place, if one exists.",
"properties": {
"type": {
"type": "string",
"example": "Polygon"
},
"coordinates": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number"
}
}
}
}
}
},
"inputInsidePolygon": {
"type": "boolean",
"example": true,
"description": "Present only when the `inputInsidePolygon` request parameter is true and this place has a boundary polygon. Indicates whether the queried lat/long falls inside it."
}
}
},
{
"type": "object",
"properties": {
"major_park": {
"type": "boolean",
"description": "Whether this is classified as a major park."
},
"facilities": {
"type": "array",
"items": {
"type": "string"
}
},
"phone_number": {
"type": "string",
"nullable": true
}
}
}
]
}
},
"transit_stops": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/paths/~1places/get/responses/200/content/application~1json/schema/properties/parks/items/allOf/0"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of transit stop (e.g. bus, subway)."
},
"walking_time": {
"nullable": true,
"description": "Estimated walking time from the queried point, if available. Exact unit/shape unconfirmed."
}
}
}
]
}
},
"safety_places": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/paths/~1places/get/responses/200/content/application~1json/schema/properties/parks/items/allOf/0"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of safety place (e.g. police, fire station, hospital)."
}
}
}
]
}
}
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1nlp/get/responses/401/content/application~1json/schema"
}
}
}
},
"401": {
"$ref": "#/paths/~1nlp/get/responses/401"
},
"403": {
"description": "Places are not enabled for this API key, or the supplied point is outside the geographic area covered by your account's boards."
}
},
"deprecated": false
}
},
"/searches": {
"post": {
"summary": "Create a saved search",
"externalDocs": {
"description": "Key Features",
"url": "https://help.repliers.com/en/article/saved-search-implementation-guide-1pomr3h/#1-key-features"
},
"description": "Use this endpoint to create a saved search for a client.
Important - the filters must be specific enough so that the initial matches do not exceed 100 listings (the default, which may be configured per account), otherwise a 406 (not accepted) response will be received. A client may have at most 5 saved searches by default (also configurable per account); exceeding that limit returns a 406.
Validation rules
clientId must belong to your account, and agentId (if supplied) must be an agent in your account that the client is assigned to.
cities and areas must match values that exist on listings in your MLS data (case-insensitive).
propertyTypes and styles must be values returned by GET /listings?listings=false&aggregates=details.propertyType,details.style.
For every min/max pair (price, beds, baths, sqft, yearBuilt, stories, coveredSpaces, lotSizeSqft, lotWidth) the minimum cannot be greater than the maximum.
map polygons must contain at least 3 distinct coordinates.",
"operationId": "create-a-saved-search",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"class",
"clientId",
"maxPrice",
"minPrice",
"type"
],
"properties": {
"clientId": {
"type": "integer",
"description": "The clientId of the client that the search is for. This client will receive notifications from the agent that's assigned to them when listings that match the saved search criteria are listed.",
"format": "int32"
},
"name": {
"type": "string",
"maxLength": 50,
"description": "You can specify a name for the saved search. This is useful in cases where users have multiple saved searches, to help them distinguish between saved searches. Maximum 50 characters."
},
"amenities": {
"type": "array",
"items": {
"type": "string"
}
},
"areas": {
"type": "array",
"description": "An array of areas to be used as a filter for this search. Required, together with cities, if neither map nor locationIds is provided.",
"items": {
"type": "string"
}
},
"basement": {
"type": "array",
"description": "If specified, matches only listings whose basement description match all of the supplied values. For a list of supported values, make a GET /listings?listings=false&aggregates=details.basement1,details.basement2 request.",
"items": {
"type": "string"
}
},
"cities": {
"type": "array",
"description": "An array of cities to be used as a filter for this search. Required, together with areas, if neither map nor locationIds is provided.",
"items": {
"type": "string"
}
},
"class": {
"type": "array",
"description": "Indicates what class of property to search for.
Allowed values:
residential,condo,commercial",
"items": {
"type": "string",
"enum": [
"residential",
"condo",
"commercial"
]
}
},
"heating": {
"type": "array",
"description": "An array of heating values to be used as a filter for this search.",
"items": {
"type": "string"
}
},
"keywords": {
"type": "array",
"items": {
"type": "string"
}
},
"neighborhoods": {
"type": "array",
"description": "An array of neighborhoods to be used as a filter for this search. Optional. Does not replace the areas and cities requirement when map is not provided.",
"items": {
"type": "string"
}
},
"notificationFrequency": {
"type": "string",
"description": "Sets the frequency that clients will be notified of listings that match their search criteria.
Allowed values:
instant, daily, weekly, monthly",
"enum": [
"instant",
"daily",
"weekly",
"monthly"
],
"default": "instant"
},
"map": {
"type": "string",
"description": "An array of polygons arrays with arrays of longitude/latitude shapes to be used as a filter for this search. If used, only listings that area geographically located within these shapes will be matched. Required if neither locationIds nor both areas and cities are provided.",
"format": "json"
},
"maxBaths": {
"type": "integer",
"description": "The maximum amount of bathrooms to be used as a filter for this search.",
"format": "int32"
},
"maxBeds": {
"type": "integer",
"description": "The maximum amount of bedrooms to be used as a filter for this search.",
"format": "int32",
"minimum": 1,
"maximum": 32767
},
"maxCoveredSpaces": {
"type": "integer",
"description": "The maximum amount of covered spaces to be used as a filter for this search.",
"format": "int32"
},
"minParkingSpaces": {
"type": "integer",
"description": "If specified, matches only listings whose parking space count is >= the supplied value.",
"format": "int32",
"minimum": 1,
"maximum": 32767
},
"maxPrice": {
"type": "integer",
"description": "The maximum list price to be used as a filter for this search.",
"format": "int32"
},
"maxStories": {
"type": "integer",
"format": "int32"
},
"maxSqft": {
"type": "integer",
"format": "int32"
},
"maxYearBuilt": {
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 32767
},
"minBaths": {
"type": "integer",
"description": "The minimum amount of bathrooms to be used as a filter for this search.",
"format": "int32"
},
"minBeds": {
"type": "integer",
"description": "The minimum amount of bedrooms to be used as a filter for this search.",
"format": "int32",
"minimum": 1,
"maximum": 32767
},
"minCoveredSpaces": {
"type": "integer",
"description": "The minimum amount of covered spaces to be used as a filter for this search.",
"format": "int32"
},
"minGarageSpaces": {
"type": "integer",
"description": "If specified, matches only listings whose garage space count is >= the supplied value.",
"format": "int32",
"minimum": 1,
"maximum": 32767
},
"minKitchens": {
"type": "integer",
"description": "If specified, matches only listings whose kitchen count is >= the supplied value.",
"format": "int32",
"minimum": 1,
"maximum": 32767
},
"maxMaintenanceFee": {
"type": "integer",
"description": "If supplied limits matches to listings where the maintenance fee is <= the supplied value.",
"format": "int32"
},
"minPrice": {
"type": "integer",
"description": "The minimum list price to be used as a filter for this search.",
"format": "int32"
},
"minStories": {
"type": "integer",
"format": "int32"
},
"minSqft": {
"type": "integer",
"format": "int32"
},
"minYearBuilt": {
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 32767
},
"pets": {
"type": "array",
"description": "An array of pet policy values to be used as a filter for this search.",
"items": {
"type": "string"
}
},
"priceChangeNotifications": {
"type": "boolean",
"description": "If set to true, clients will receive price change notifications for listings that have been matched for them.",
"default": false
},
"propertyTypes": {
"type": "array",
"description": "An array of property types to be used as a filter for this search.",
"items": {
"type": "string"
}
},
"sewer": {
"type": "array",
"description": "An array of sewer values to be used as a filter for this search.",
"items": {
"type": "string"
}
},
"status": {
"type": "boolean",
"description": "If set to false, disables this search.",
"default": true
},
"soldNotifications": {
"type": "boolean",
"description": "If set to true, clients will receive sold notifications for listings that have been matched for them.",
"default": false
},
"streetNames": {
"type": "array",
"description": "An array of street names to be used as a filter for this search.",
"items": {
"type": "string"
}
},
"streetNumbers": {
"type": "array",
"description": "An array of street numbers to be used as a filter for this search.",
"items": {
"type": "string"
}
},
"styles": {
"type": "array",
"description": "An array of property styles to be used as a filter for this search.",
"items": {
"type": "string"
}
},
"swimmingPool": {
"type": "array",
"description": "An array of swimming pool values to be used as a filter for this search.",
"items": {
"type": "string"
}
},
"type": {
"type": "string",
"description": "Indicates whether the search is for a property that's for sale or for lease.
Allowed values:
sale,lease",
"enum": [
"sale",
"lease"
]
},
"waterSource": {
"type": "array",
"description": "An array of water source values to be used as a filter for this search.",
"items": {
"type": "string"
}
},
"minLotSizeSqft": {
"type": "integer",
"format": "int32",
"description": "The minimum lot size in square feet to be used as a filter for this search."
},
"maxLotSizeSqft": {
"type": "integer",
"format": "int32",
"description": "The maximum lot size in square feet to be used as a filter for this search."
},
"minLotWidth": {
"type": "number",
"format": "float",
"description": "The minimum lot width to be used as a filter for this search. If specified, matches only listings whose lot width is >= the supplied value. Must be greater than 0 and cannot be greater than maxLotWidth. The unit of measurement is the same as the one the MLS board provides in its data."
},
"maxLotWidth": {
"type": "number",
"format": "float",
"description": "The maximum lot width to be used as a filter for this search. If specified, matches only listings whose lot width is <= the supplied value. Must be greater than 0 and cannot be less than minLotWidth. The unit of measurement is the same as the one the MLS board provides in its data."
},
"minOpenHouseDate": {
"description": "Indicates whether the search is for properties that have an Open House on or after the supplied date. Date format: YYYY-MM-DD",
"type": "string",
"format": "date"
},
"maxOpenHouseDate": {
"description": "Indicates whether the search is for properties that have an Open House on or before the supplied date. Date format: YYYY-MM-DD. It's not recommended to use it unless you have a very good reason to set it.",
"type": "string",
"format": "date"
},
"standardStatus": {
"type": "array",
"description": "Indicates what Standard Status of property to search for.
Allowed values:
Active, Active Under Contract, Closed, Expired, Pending, Canceled, Incomplete",
"items": {
"type": "string",
"enum": [
"Active",
"Active Under Contract",
"Closed",
"Expired",
"Pending",
"Canceled",
"Incomplete"
]
}
},
"fields": {
"type": "object",
"description": "An object of raw MLS field filters to be used for this search. Each key is a raw field name and each value is an array of possible values for that field. Raw field names must be prefixed with raw., for example raw.Room13level or raw.PropertyUse. Supports up to 50 fields and up to 50 values per field.
Example: {\"raw.Room13level\": [\"Main\"]}",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
},
"example": {
"raw.Room13level": [
"Main"
]
}
},
"locationIds": {
"type": "array",
"description": "An array of locationIds (see GET /locations) to be used as a filter for this search. If provided, map, areas and cities are not required. Values must be alphanumeric. Duplicates are removed.",
"items": {
"type": "string",
"maxLength": 100,
"pattern": "^[A-Za-z0-9]+$"
}
},
"agentId": {
"type": "integer",
"description": "The agentId of the agent that the search is assigned to. Must be an agent in your account that the client is assigned to. If not specified, defaults to the agent assigned to the client.",
"format": "int32"
}
}
},
"examples": {
"Request Example": {
"value": {
"notificationFrequency": "instant",
"priceChangeNotifications": false,
"status": true,
"soldNotifications": false,
"class": [
"residential"
],
"minPrice": 100000,
"maxPrice": 1000000,
"type": "sale",
"clientId": 123456
}
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"searchId\": 73030,\n \"name\": null,\n \"createdOn\": \"2025-05-22T22:05:01.000Z\",\n \"agentId\": 106715,\n \"minBeds\": 2,\n \"maxBeds\": 3,\n \"minBaths\": 2,\n \"maxBaths\": null,\n \"minPrice\": 400000,\n \"maxPrice\": 1000000,\n \"maxMaintenanceFee\": null,\n \"minGarageSpaces\": null,\n \"minParkingSpaces\": null,\n \"minKitchens\": null,\n \"minSqft\": null,\n \"maxSqft\": null,\n \"minYearBuilt\": null,\n \"maxYearBuilt\": null,\n \"minStories\": null,\n \"maxStories\": null,\n \"maxCoveredSpaces\": null,\n \"minCoveredSpaces\": null,\n \"status\": true,\n \"type\": \"sale\",\n \"clientId\": 147150,\n \"streetNumbers\": [],\n \"streetNames\": [],\n \"cities\": [\"\"],\n \"neighborhoods\": [\"\"],\n \"propertyTypes\": [],\n \"styles\": [],\n \"areas\": [\"\"],\n \"map\": [],\n \"class\": [\"residential\"],\n \"basement\": [],\n \"client\": {\n \"fname\": \"FirstName\",\n \"lname\": \"LastName\",\n \"email\": \"client@example.com\",\n \"phone\": \"1234567890\"\n },\n \"notificationFrequency\": \"instant\",\n \"soldNotifications\": false,\n \"priceChangeNotifications\": false,\n \"sewer\": [],\n \"waterSource\": [],\n \"heating\": [],\n \"swimmingPool\": [],\n \"amenities\": [],\n \"keywords\": [],\n \"pets\": []\n}"
}
},
"schema": {
"type": "object",
"properties": {
"searchId": {
"type": "integer",
"example": 73030
},
"name": {
"type": "string",
"nullable": true,
"example": "Downtown Condo Search",
"description": "An optional label for this saved search."
},
"createdOn": {
"type": "string",
"example": "2025-05-22T22:05:01.000Z"
},
"agentId": {
"type": "integer",
"example": 106715
},
"minBeds": {
"type": "integer",
"nullable": true,
"example": 2
},
"maxBeds": {
"type": "integer",
"nullable": true,
"example": 3
},
"minBaths": {
"type": "integer",
"nullable": true,
"example": 2
},
"maxBaths": {
"type": "integer",
"nullable": true,
"example": 3
},
"minPrice": {
"type": "integer",
"nullable": true,
"example": 400000
},
"maxPrice": {
"type": "integer",
"nullable": true,
"example": 1000000
},
"maxMaintenanceFee": {
"type": "number",
"nullable": true,
"example": 600
},
"minGarageSpaces": {
"type": "integer",
"nullable": true,
"example": 1
},
"minParkingSpaces": {
"type": "integer",
"nullable": true,
"example": 2
},
"minKitchens": {
"type": "integer",
"nullable": true,
"example": 1
},
"minSqft": {
"type": "integer",
"nullable": true,
"example": 1200
},
"maxSqft": {
"type": "integer",
"nullable": true,
"example": 3000
},
"minYearBuilt": {
"type": "integer",
"nullable": true,
"example": 1990
},
"maxYearBuilt": {
"type": "integer",
"nullable": true,
"example": 2024
},
"minLotSizeSqft": {
"type": "integer",
"nullable": true,
"example": 5000
},
"maxLotSizeSqft": {
"type": "integer",
"nullable": true,
"example": 10000
},
"minLotWidth": {
"type": "number",
"format": "float",
"nullable": true,
"example": 20,
"description": "The minimum lot width filter applied to this search, if set. The unit of measurement is the same as the one the MLS board provides in its data."
},
"maxLotWidth": {
"type": "number",
"format": "float",
"nullable": true,
"example": 50,
"description": "The maximum lot width filter applied to this search, if set. The unit of measurement is the same as the one the MLS board provides in its data."
},
"minOpenHouseDate": {
"type": "string",
"nullable": true,
"example": "2024-06-15",
"description": "Filters matches to listings with an open house on or after this date."
},
"maxOpenHouseDate": {
"type": "string",
"nullable": true,
"example": "2024-07-15",
"description": "Filters matches to listings with an open house on or before this date."
},
"minStories": {
"type": "integer",
"nullable": true,
"example": 1
},
"maxStories": {
"type": "integer",
"nullable": true,
"example": 2
},
"maxCoveredSpaces": {
"type": "integer",
"nullable": true,
"example": 2
},
"minCoveredSpaces": {
"type": "integer",
"nullable": true,
"example": 1
},
"status": {
"type": "boolean",
"example": true
},
"type": {
"type": "string",
"example": "sale"
},
"clientId": {
"type": "integer",
"example": 147150
},
"streetNumbers": {
"type": "array",
"items": {
"type": "string",
"example": "12103"
}
},
"streetNames": {
"type": "array",
"items": {
"type": "string",
"example": "Cypresswood"
}
},
"cities": {
"type": "array",
"items": {
"type": "string",
"example": ""
}
},
"neighborhoods": {
"type": "array",
"items": {
"type": "string",
"example": ""
}
},
"propertyTypes": {
"type": "array",
"items": {
"type": "string",
"example": "Detached"
}
},
"styles": {
"type": "array",
"items": {
"type": "string",
"example": "2-Storey"
}
},
"areas": {
"type": "array",
"items": {
"type": "string",
"example": ""
}
},
"map": {
"type": "array",
"description": "A GeoJSON polygon/multi-polygon boundary used to filter matches geographically, in the same format as the `map` parameter on [POST /listings](/reference/post_listings)."
},
"mapType": {
"type": "string",
"nullable": true,
"example": "polygon",
"description": "The type of the `map` boundary (e.g. polygon, multipolygon), if set."
},
"class": {
"type": "array",
"items": {
"type": "string",
"example": "residential"
}
},
"basement": {
"type": "array",
"items": {
"type": "string",
"example": "Finished"
}
},
"client": {
"type": "object",
"properties": {
"fname": {
"type": "string",
"example": "FirstName"
},
"lname": {
"type": "string",
"example": "LastName"
},
"email": {
"type": "string",
"example": "client@example.com"
},
"phone": {
"type": "string",
"example": "1234567890"
}
}
},
"notificationFrequency": {
"type": "string",
"example": "instant"
},
"soldNotifications": {
"type": "boolean",
"example": false
},
"priceChangeNotifications": {
"type": "boolean",
"example": false
},
"sewer": {
"type": "array",
"items": {
"type": "string",
"example": "Public Sewer"
}
},
"waterSource": {
"type": "array",
"items": {
"type": "string",
"example": "Public"
}
},
"heating": {
"type": "array",
"items": {
"type": "string",
"example": "Natural Gas"
}
},
"swimmingPool": {
"type": "array",
"items": {
"type": "string",
"example": "In Ground"
}
},
"amenities": {
"type": "array",
"items": {
"type": "string",
"example": "Gym"
}
},
"keywords": {
"type": "array",
"items": {
"type": "string",
"example": "waterfront"
}
},
"pets": {
"type": "array",
"items": {
"type": "string",
"example": "Restricted"
}
},
"standardStatus": {
"type": "string",
"nullable": true,
"example": "Active",
"description": "The standardized status filter applied to matches, if set."
},
"fields": {
"type": "object",
"nullable": true,
"description": "The raw MLS field filters applied to this search, if set. Each key is a raw field name prefixed with raw. and each value is an array of values for that field. Returns null when no raw field filters are set.",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
},
"example": {
"raw.Room13level": [
"Main"
]
}
}
}
}
}
}
},
"400": {
"$ref": "#/paths/~1places/get/responses/400"
},
"401": {
"$ref": "#/paths/~1nlp/get/responses/401"
},
"406": {
"description": "Not accepted. Returned in two cases - the filters are not specific enough and the initial matches exceed 100 listings (the default, configurable per account), or the client has already reached the maximum number of saved searches allowed for your account (5 by default, configurable per account).",
"content": {
"text/plain": {
"examples": {
"Too many matches": {
"value": "When a saved search is created the filters must be specific enough so that the initial matches do not exceed 100 listings otherwise a 406 (not accepted) response will be received."
},
"Saved search limit": {
"value": "A client can have a maximum of 5 searches."
}
}
}
}
}
},
"deprecated": false
}
},
"/nlp": {
"get": {
"summary": "Filter prompts",
"description": "This endpoint allows you to list and filter prompts across all sessions.\n",
"tags": [
"NLP"
],
"parameters": [
{
"name": "nlpId",
"in": "query",
"description": "Unique identifier for the NLP session.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "clientId",
"in": "query",
"description": "Filter sessions based on the `clientId` to see all NLP sessions associated with a specific client.",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "pageNum",
"in": "query",
"description": "The page number to return. For example, with 100 results per page, specifying pageNum=2 returns results 101–200.",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"default": 1
}
},
{
"name": "resultsPerPage",
"in": "query",
"description": "The number of prompts to return per page.",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 100
}
}
],
"responses": {
"200": {
"description": "Successful response with NLP session data.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "Current page number"
},
"numPages": {
"type": "integer",
"description": "Total number of pages"
},
"pageSize": {
"type": "integer",
"description": "Number of results per page"
},
"count": {
"type": "integer",
"description": "Total number of results"
}
}
},
{
"type": "object",
"properties": {
"prompts": {
"type": "array",
"description": "List of NLP prompts and their responses",
"items": {
"allOf": [
{
"$ref": "#/paths/~1nlp/post/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"$ref": "#/paths/~1nlp/post/responses/200/content/application~1json/schema/allOf/1/properties/request"
}
}
}
]
}
}
}
}
]
}
}
}
},
"401": {
"description": "The API key was not recognized by the API server, or the key is not active.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"param": {
"type": "string"
},
"msg": {
"type": "string"
}
}
}
}
}
}
}
},
"500": {
"description": "Internal Server Error - An error occurred while processing the request."
}
}
}
}
},
"x-readme": {
"headers": [],
"explorer-enabled": true,
"proxy-enabled": true
},
"x-readme-fauxas": true
}
```