Retrieves a list of all locations associated with your company.
Table Specific Information
Query the Locations table. The component will use the TSheets API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the component.
- Id and GeoCodingStatus fields support the '=' and IN operators.
- Active field supports the '=' operator.
- LastModified field supports the <=,<,>=,>,= operators.
For example, the following queries are processed server side:
SELECT * FROM Locations WHERE GeoCodingStatus IN ('in_progress', 'retry') SELECT * FROM Locations WHERE ByJobcodeAssignment = true
|Id [KEY]||String||Id of location.|
|Address1||String||The first line of the location's address.|
|Address2||String||The second line of the location's address.|
|City||String||The city of the location's address.|
|State||String||The state of the location's address.|
|Zip||String||The postal code of the location's address.|
|Country||String||The country of the location's address.|
|FormattedAddress||String||Formatted address built from the objects addr1, addr2, city, state, and zip. If the location doesn't contain addr1, addr2, or city properties, the value will default what is set in the label property.|
|Active||Boolean||Whether this location is active. If false, this location is archived.|
|Latitude||Double||The latitude of the location (in signed degrees format).|
|Longitude||Double||The longitude of the location (in signed degrees format).|
|PlaceIdHash||Double||The MD5 hash of the unique id for the location returned from the geocoding service.|
|Label||String||The formated name for the location. If the location was found using the geocode service the formated address will be saved in this field, otherwise it will be what the user has named the location.|
|Notes||String||Notes related to the location.|
|GeoCodingStatus||String||The geocoding status of this address. Will be one of: 'none', 'in_progress', 'retry', 'error', or 'complete'.|
|Created||Datetime||Date/time when this location was created|
|LastModified||Datetime||Date/time when this customfield was last modified.|
|LinkedObjects||String||A key/value map of all the objects linked to this location and the corresponding object ids.|
|GeofenceConfigId||Int||Id of the geofence_config associated with this location.|
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
|ByJobcodeAssignment||Boolean||If specified, only locations mapped to a jobcode the user is assigned to will be returned.|