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:

Name Description Data Type
query (Required) String indicating the text to search for
string

Response

Name Description Data Type
Id Unique placeset identifier
Int
ModifiedOn Indicates the last time the place was modified
DateTime
SetId Unique set identifier to which this place belongs
Int
PlaceName Name of the place
string
ExternalPlaceId Unique external place Id
Alphanumeric
SiteId Unique identifier for site around the place
Int
Address Address of the location (See below)
Complex
Coords Coordinates of the location (See below)
Complex
Info Comments or description about a place
string
Phone Phone number of the place
string
href Link to the next page in the response
string
method HTTP Request type to retrieve the next page
string

Address

Data Description Data Type
StreetAddress The house number and street name
string
City The name of the city
string
State The two letter state abbreviation
string
PostalCode The postal code or zip
string
Country The name of the country
string

Coords

Data Description Data Type
Lat Latitude as a signed decimal with 6 digits to the right of the decimal. (For example, 40.360621)
string
Lon Longitude 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"
  }
}