Search for Places

GET /places

Returns an array of up to 20 custom locations that match with the search text.

Request

Authorization: bearer {token}

Parameters:

NameDescriptionData Type
query(Required) String indicating the text to search forstring

Response

NameDescriptionData Type
IdUnique placeset identifierInt
ModifiedOnIndicates the last time the place was modifiedDateTime
SetIdUnique set identifier to which this place belongsInt
PlaceNameName of the placestring
ExternalPlaceIdUnique external place IdAlphanumeric
SiteIdUnique identifier for site around the placeInt
AddressAddress of the location (See below)Complex
CoordsCoordinates of the location (See below)Complex
InfoComments or description about a placestring
PhonePhone number of the placestring
hrefLink to the next page in the responsestring
methodHTTP Request type to retrieve the next pagestring

Address

DataDescriptionData Type
StreetAddressThe house number and street namestring
CityThe name of the citystring
StateThe two letter state abbreviationstring
PostalCodeThe postal code or zipstring
CountryThe name of the countrystring

Coords

DataDescriptionData Type
LatLatitude as a signed decimal with 6 digits to the right of the decimal. (For example, 40.360621)string
LonLongitude as a signed decimal with 6 digits to the right of the decimal. (For example, -74.599027)string

Sample Response

{
  "data": [
    {
      "Id": 10387225,
      "ModifiedOn": "0001-01-01T00:00:00",
      "SetId": 0,
      "PlaceName": "Monroe Location 1",
      "ExternalPlaceId": null,
      "Address": {
        "StreetAddress": "",
        "City": "Monroe Township",
        "State": "NJ",
        "PostalCode": "08831",
        "Country": null
      },
      "Coords": {
        "Lat": "40.346806",
        "Lon": "-74.442549"
      },
      "Info": null,
      "Phone": ""
    },
    {
      "Id": 10387226,
      "ModifiedOn": "0001-01-01T00:00:00",
      "SetId": 0,
      "PlaceName": "Monroe Location 2",
      "ExternalPlaceId": null,
      "Address": {
        "StreetAddress": "",
        "City": "Monroe Twp",
        "State": "NJ",
        "PostalCode": "08831",
        "Country": null
      },
      "Coords": {
        "Lat": "40.346806",
        "Lon": "-74.442549"
      },
      "Info": null,
      "Phone": ""
    }
  ],
  "next": {
    "href": "https://contentapi.trimblemaps.com/api/v1/places?lastPlaceId=200767976&lastModified=2019-02-25T17%3A41%3A44.46%2B00%3A00&pageSize=2",
    "method": "GET"
  }
}