REQUEST
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_places
disabled 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 code.
0
indicates success.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 withlat
andlng
radius
(integer): Check-in radius in meterscolor
(string): Color code in hex formatcreator
(string): Name of user who created the placelinkedForms
(string): Linked form IDsdata
(array): Extended custom data as key-value pairs