Skip to main content

Get a Place

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

GET /places/{placeId}

Returns information about a place using the unique placeId.

Request

Authorization: bearer {token}

Response

NameDescriptionData Type
IdUnique place identifier
Int
DeletedIndicates whether place still exists. Note that this call will not get back deleted places
boolean
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
Complex
CoordsCoordinates of the location
Complex
InfoComments or description about a place
string
PhonePhone number of the place
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": 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.
Last updated November 29, 2022.