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
| Name
| Description
| Data Type
|
Id
| Unique place identifier
|
Int
|
Deleted
| Indicates whether place still exists. Note that this call will not get back deleted places
|
boolean
|
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
|
Complex
|
Coords
| Coordinates of the location
|
Complex
|
Info
| Comments or description about a place
|
string
|
Phone
| Phone number of the place
|
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": 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
| Message
| Description
|
| Cannot find item with supplied id
| This error is thrown when the placeId does not belong to the account.
|