Get a Place

GET /places/{placeId}

Returns information about a place using the unique placeId.

Request

Authorization: bearer {token}

Response

NameDescriptionData Type
IdUnique place identifierInt
DeletedIndicates whether place still exists. Note that this call will not get back deleted placesboolean
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 locationComplex
CoordsCoordinates of the locationComplex
InfoComments or description about a placestring
PhonePhone number of the placestring

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": 6017941,
      "Deleted": false,
      "SetId": 162288,
      "PlaceName": "Business Location 3",
      "ExternalPlaceId": null,
      "SiteId": 123456,
      "Address": {
        "StreetAddress": "18320 Bixby Avenue",
        "City": "Elgin",
        "State": "IA",
        "PostalCode": "52141",
        "Country": "US"
      },
      "Coords": {
        "Lat": "42.959849",
        "Lon": "-91.55673"
      },
      "Info": null,
      "Phone": null
    }
  ]
}

Error Codes

MessageDescription
Cannot find item with supplied idThis error is thrown when the placeId does not belong to the account.