GET api/Homes/Search?q={q}&maxResults={maxResults}&lat={lat}&lon={lon}

Returns the list of homes searched from CRM. Note: Requires a valid access token to be provided in the request's auth header.

Request Information

URI Parameters

Name	Description	Type	Additional information
q	search string.	string	Required
maxResults	max number of homes returned.	integer	Default value is 10
lat	lattitude.	decimal number	None.
lon	longitude.	decimal number	None.

Body Parameters

Entity.

Entity

Name	Type	Additional information
LogicalName	string	Optional
Id	globally unique identifier	Optional
Attributes	Collection of Object	Optional
EntityState	EntityState	Optional
FormattedValues	Collection of Object	Optional
RelatedEntities	Collection of Object	Optional

Request Formats

application/json, text/json

Sample:

Sample not available.

Response Information

Resource Description

List of CrmHomeSearch

Collection of CrmHomeSearch

Name	Description	Type	Additional information
City	City the home is located in.	string	Optional
State	State the home is located in.	string	Optional
ZipCode	Zipcode the home is located in.	string	Optional
StreetAddress1	First line of street address for home.	string	Optional
StreetAddress2	Second line of street address for home.	string	Optional
PropertyId	Internal property id for home.	string	Optional
Latitude	Latitude the home is located on.	decimal number	Optional
Longitude	Longitude the home is located on.	decimal number	Optional
Reference	Used to reference the home in CRM.	EntityReference	Required
Location		GeoCoordinate	Optional
LatAsDouble		decimal number	Optional
LongAsDouble		decimal number	Optional
SystemDate	Current system date of the client that created this object.	date	Optional
CapturedDate	Date and time the client created this object.	date	Optional

Response Formats

application/json, text/json

Sample:

[
  {
    "City": "sample string 1",
    "State": "sample string 2",
    "ZipCode": "sample string 3",
    "StreetAddress1": "sample string 4",
    "StreetAddress2": "sample string 5",
    "PropertyId": "sample string 6",
    "Latitude": 1.0,
    "Longitude": 1.0,
    "Reference": {
      "Id": "bcd2a96f-7ab3-45dc-b3ff-c14d39a1b83f",
      "LogicalName": "sample string 2",
      "Name": "sample string 3"
    },
    "Location": {
      "Latitude": 1.1,
      "Longitude": 2.1,
      "Altitude": 3.1,
      "HorizontalAccuracy": 4.1,
      "VerticalAccuracy": 5.1,
      "Speed": 6.1,
      "Course": 7.1,
      "IsUnknown": false
    },
    "LatAsDouble": 1.0,
    "LongAsDouble": 1.0,
    "SystemDate": "2025-05-23T16:01:37.3850612-05:00",
    "CapturedDate": "2025-05-23T16:01:37.3850612-05:00"
  },
  {
    "City": "sample string 1",
    "State": "sample string 2",
    "ZipCode": "sample string 3",
    "StreetAddress1": "sample string 4",
    "StreetAddress2": "sample string 5",
    "PropertyId": "sample string 6",
    "Latitude": 1.0,
    "Longitude": 1.0,
    "Reference": {
      "Id": "bcd2a96f-7ab3-45dc-b3ff-c14d39a1b83f",
      "LogicalName": "sample string 2",
      "Name": "sample string 3"
    },
    "Location": {
      "Latitude": 1.1,
      "Longitude": 2.1,
      "Altitude": 3.1,
      "HorizontalAccuracy": 4.1,
      "VerticalAccuracy": 5.1,
      "Speed": 6.1,
      "Course": 7.1,
      "IsUnknown": false
    },
    "LatAsDouble": 1.0,
    "LongAsDouble": 1.0,
    "SystemDate": "2025-05-23T16:01:37.3850612-05:00",
    "CapturedDate": "2025-05-23T16:01:37.3850612-05:00"
  }
]