Search

Finds any Place where the name or Custom PlaceId matches the query provided.

get/places/v1/place/search

Request

  • Base URL: https://api.trimblemaps.com
  • URL: https://api.trimblemaps.com/places/v1/place/search
  • Auth: API key in header Authorization

Query parameters

querystring

The search parameter.

Offsetinteger
Limitinteger
SortExpressionstring
SortDirectionstring
regionstring

Optional region parameter.

Response

Success

hrefstring nullable
methodstring nullable
offsetinteger nullable
limitinteger nullable
sizeinteger
dateCollectedstring date-time nullable

Example response

{
  "data": [
    {
      "trimblePlaceId": "0x6MTu_03diEyV9O5tusIVFg",
      "customPlaceId": "TRIMB57",
      "name": "Schneider Dairy",
      "categoryName": "Distribution Center",
      "formattedAddress": "123 Main Street, Pittsburgh, PA  15212",
      "status": "Temporarily Closed"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.