GET
/
work-locations
/
public
/
api
/
work-locations
curl --request GET \
  --url https://{host}/work-locations/public/api/work-locations \
  --header 'Authorization: <authorization>'
{
  "count": 123,
  "items": [
    {
      "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
    }
  ]
}

Headers

​
Authorization
string
required

API key. Value must be formatted like so: lucca application={api_key}.

Query Parameters

​
page
integer
default:1

Page number

Required range: x >= 1
​
limit
integer
default:10

Page size

Required range: 1 <= x <= 10
​
fields.root
enum<string>

Return total items count (across all pages).

Available options:
count

Response

200
application/json
OK
​
count
integer
​
items
object[]

Represents a location an employee can work from

Was this page helpful?