cURL
curl --request GET \ --url https://{host}/work-locations/public/api/work-locations \ --header 'Authorization: <authorization>'
{ "count": 123, "items": [ { "id": 123, "name": "<string>", "type": "Office", "isActive": true, "office": { "capacity": 123, "showAreas": true, "areas": [ { "id": 123, "name": "<string>", "capacity": 123, "floorKey": 123 } ], "floors": [ { "key": 123, "name": "<string>", "position": 123 } ] } } ] }
Query all available work locations
API key. Value must be formatted like so: lucca application={api_key}.
lucca application={api_key}
Page number
x >= 1
Page size
1 <= x <= 1000
Return total items count (across all pages).
count
OK
Show child attributes
The unique id of the WorkLocation.
The name of the WorkLocation
Type of WorkLocation. It can be physical, like an office, but also abstract, RemoteWork is for telecommuting which has specific rules in Lucca Office, and Other allows to suggest any other locations, like on the go.
Office
RemoteWork
Other
Indicates whether the location is currently active
The office details, non-null if the location type is "Office"
The number of people the office can accommodate
Whether to show specific areas within the office
A office can be divided into different areas defined by a name and capacity
The Area's unique identifier.
The Area's name.
The number of people the Area can accommodate.
The floor's unique identifier.
The floor's name.
The floor's position in order of display.
Was this page helpful?