Place Object Structure
Core Properties
Read-only. Unique identifier for the place. Automatically generated by the system.
Read/Write. Name of the place. This is the only required field when creating a place.Example: 
"Downtown Office", "Customer Site #101"Read-only. Name of the user or company that created this place.
Location & Address
Read/Write. Geographic coordinates of the place.
- lat(DOUBLE): Latitude
- lng(DOUBLE): Longitude
Read/Write. Street address.Example: 
"123 Main Street", "Suite 400, 456 Market Street"Read/Write. City name.
Read/Write. State, province, or region.Example: 
"California", "CA", "Ontario"Read/Write. Postal code or ZIP code.
Read/Write. ISO country code (2 letters).Example: 
"US", "GB", "DE", "CA"Read/Write. Check-in radius in meters. Determines how close a worker needs to be to check in at this location.Default: 
0Common values: 50, 100, 200Contact Information
Read/Write. Contact phone number for this location.Example: 
"+14155551234"Read/Write. Contact email address for this location.Example: 
"contact@location.com"Visual & Configuration
Read/Write. Color code in hexadecimal format for display in maps and lists.Example: 
"#22c328", "#FF5733"Read/Write. Comma-separated list of form IDs linked to this place. When a job is created at this location, these forms can be automatically attached.Example: 
"form1,form2,form3"Team Assignment & Access
Places can be assigned to specific teams within your organization. This is managed through:- teams (ARRAY of integers): Team numbers that have access to this place
- Team-based filtering applies when retrieving places
- Workers may only see places from their assigned teams (based on company settings)
Custom Data Fields
Read/Write. Array of custom key-value pair objects for storing additional information.Each object contains one key-value pair:Use this for storing:
- Manager or contact names
- Operating hours
- Capacity information
- Special instructions
- Custom business data
Usage in API Endpoints
Creating Places
When creating a place with/api/createplace:
- Only nameis required
- If locationcoordinates are not provided, geocoding will attempt to resolve them from address fields
- extended_dataparameter is used instead of- datain requests
Editing Places
When editing with/api/editplace:
- Include only the fields you want to update
- Use uidto identify the place
- Or use uidsarray for batch updates
Retrieving Places
When retrieving with/api/getplaces:
- Returns array of complete place objects
- Automatically filtered by permissions and teams
- Sorted by distance from your location
Permissions & Visibility
Place visibility and access is controlled by:- 
Company Settings:
- workers_create_places: Controls if workers can create new places
- workers_view_places: Controls if workers can see all places or only team-assigned ones
 
- 
Team Assignment:
- Places can be restricted to specific teams
- Workers only see places from their teams (when restricted)
 
- 
Personal vs. Company Places:
- Company places belong to the organization
- Personal places can be shared with network using visibility: "network"
 
Common Use Cases
Customer Sites
Service Locations
Warehouses
Related Endpoints
- Get Places - Retrieve places
- Create Place - Create a new place
- Edit Place - Update place properties
- Get Jobs - Jobs can be associated with places
Notes
Geocoding: When creating places without coordinates, provide at least 
address + city + country_code or city + state + country_code for best geocoding results.Extended Data: In API requests, use 
extended_data parameter with objects containing key and val properties. In responses, this appears as the data array with single key-value objects.Check-in Radius: Set an appropriate radius for your use case. Smaller radii (50-100m) for precise locations, larger radii (200-500m) for general areas or zones.