curl -X POST https://api.hellotracks.com/api/getplaces --header 'API-Key: ...' -d '
{
"data": {}
}
'
{
"places":[
{
"address":"1199 East Beach Road, San Francisco, California 94129, United States",
"color":"",
"creator":"Acme Dispatch",
"data":[
],
"city":"San Francisco",
"uid":"p1q2r3",
"country_code":"US",
"phone":"",
"postalcode":"94129",
"name":"East beach",
"location":{
"lng":-122.449046,
"lat":37.8059467
},
"state":"California",
"radius":50,
"email":"",
"linkedForms":""
}
],
"status":0
}
Place Management
Get Places
Retrieve places (locations/sites) for your organization.
POST
/
api
/
getplaces
curl -X POST https://api.hellotracks.com/api/getplaces --header 'API-Key: ...' -d '
{
"data": {}
}
'
{
"places":[
{
"address":"1199 East Beach Road, San Francisco, California 94129, United States",
"color":"",
"creator":"Acme Dispatch",
"data":[
],
"city":"San Francisco",
"uid":"p1q2r3",
"country_code":"US",
"phone":"",
"postalcode":"94129",
"name":"East beach",
"location":{
"lng":-122.449046,
"lat":37.8059467
},
"state":"California",
"radius":50,
"email":"",
"linkedForms":""
}
],
"status":0
}
Use this endpoint to retrieve places/locations associated with your organization. Places can represent customer sites, warehouses, offices, or any fixed locations relevant to your operations.
REQUEST
POST https://api.hellotracks.com/api/getplaces
{
"data": {
"query": "<place-name>",
"uids": ["<place-uid>"],
"max": 500
}
}
Optional filter to search places by name. Case-insensitive substring match. Minimum 3 characters recommended.
Optional array of specific place UIDs to retrieve. When provided, only these places will be returned (subject to permissions).
Maximum number of places to return. Default is 500. Some accounts may have different limits.
Permissions & Filtering
- Workers with
workers_view_placesdisabled can only see places from their assigned teams - Places are automatically filtered by distance from your location (closest first)
- Only places you have permission to view will be returned
RESPONSE
{
"status": 0,
"places": [
{
"uid": "<place-uid>",
"name": "Place name",
"address": "Full address",
"city": "City",
"state": "State/Region",
"postalcode": "Postal code",
"country_code": "US",
"phone": "+1234567890",
"email": "email@example.com",
"location": {
"lat": 37.7749,
"lng": -122.4194
},
"radius": 100,
"color": "#22c328",
"linkedForms": "",
"creator": "Acme Dispatch",
"data": []
}
]
}
Array of place objects. Each place contains:
uid(string): Unique place identifiername(string): Place nameaddress(string): Street addresscity(string): City namestate(string): State or regionpostalcode(string): Postal/ZIP codecountry_code(string): ISO country codephone(string): Contact phone numberemail(string): Contact email addresslocation(object): Coordinates withlatandlngradius(integer): Check-in radius in meterscolor(string): Color code in hex formatlinkedForms(string): Linked form IDscreator(string): Creator name when availabledata(array): Extended custom data as single-key objects
curl -X POST https://api.hellotracks.com/api/getplaces --header 'API-Key: ...' -d '
{
"data": {}
}
'
{
"places":[
{
"address":"1199 East Beach Road, San Francisco, California 94129, United States",
"color":"",
"creator":"Acme Dispatch",
"data":[
],
"city":"San Francisco",
"uid":"p1q2r3",
"country_code":"US",
"phone":"",
"postalcode":"94129",
"name":"East beach",
"location":{
"lng":-122.449046,
"lat":37.8059467
},
"state":"California",
"radius":50,
"email":"",
"linkedForms":""
}
],
"status":0
}