GET
/
work-locations
/
public
/
api
/
work-locations
/
{id}
curl --request GET \
  --url https://{account}-{sandboxName}.sandbox.{server}.luccasoftware.com/work-locations/public/api/work-locations/public/api/work-locations/{id}
{
  "id": 123,
  "name": "<string>",
  "type": "Office",
  "office": {
    "capacity": 123,
    "showAreas": true,
    "areas": [
      {
        "id": 123,
        "name": "<string>",
        "capacity": 123,
        "floorKey": 123
      }
    ],
    "floors": [
      {
        "key": 123,
        "name": "<string>",
        "position": 123
      }
    ]
  },
  "isActive": true
}

Path Parameters

​
id
integer
required

Unique id of the work location

Response

200
application/json
OK

Represents a location an employee can work from

​
id
number
required

The unique id of the WorkLocation.

​
name
string
required

The name of the WorkLocation

​
type
enum<string>
required

Type of WorkLocation. It can be physical, like an office, but also abstract, RemoteWork is for telecommuting which has specific rules in Timmi Office, and Other allows to suggest any other locations, like on the go.

Available options:
Office,
RemoteWork,
Other
​
isActive
boolean
required

Indicates whether the location is currently active

​
office
object

The office details, non-null if the location type is "Office"

Was this page helpful?

List workLocationsThe client resource