Skip to main content
POST
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

​
string
Optional filter to search places by name. Case-insensitive substring match. Minimum 3 characters recommended.
​
array
Optional array of specific place UIDs to retrieve. When provided, only these places will be returned (subject to permissions).
​
integer
default:500
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

​
integer
required
Status code. 0 indicates success.
​
array
required
Array of place objects. Each place contains:
  • uid (string): Unique place identifier
  • name (string): Place name
  • address (string): Street address
  • city (string): City name
  • state (string): State or region
  • postalcode (string): Postal/ZIP code
  • country_code (string): ISO country code
  • phone (string): Contact phone number
  • email (string): Contact email address
  • location (object): Coordinates with lat and lng
  • radius (integer): Check-in radius in meters
  • color (string): Color code in hex format
  • linkedForms (string): Linked form IDs
  • creator (string): Creator name when available
  • data (array): Extended custom data as single-key objects