Skip to main content

Search for Places

Contents

The ContentTools API has been deprecated and replaced by the Places API.

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 for
string

Response

NameDescriptionData Type
IdUnique placeset identifier
Int
ModifiedOnIndicates the last time the place was modified
DateTime
SetIdUnique set identifier to which this place belongs
Int
PlaceNameName of the place
string
ExternalPlaceIdUnique external place Id
Alphanumeric
SiteIdUnique identifier for site around the place
Int
AddressAddress of the location (See below)
Complex
CoordsCoordinates of the location (See below)
Complex
InfoComments or description about a place
string
PhonePhone number of the place
string
hrefLink to the next page in the response
string
methodHTTP Request type to retrieve the next page
string

Address

DataDescriptionData Type
StreetAddressThe house number and street name
string
CityThe name of the city
string
StateThe two letter state abbreviation
string
PostalCodeThe postal code or zip
string
CountryThe name of the country
string

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"
  }
}
Last updated December 2, 2022.
Contents