Skip to main content
GET
/
schedule
/
api
/
working-time-arrangements
/
{workingTimeArrangementId}
/
collective-schedules
List Collective Schedules from a Working Time Arrangement
curl --request GET \
  --url https://{host}/schedule/api/working-time-arrangements/{workingTimeArrangementId}/collective-schedules \
  --header 'Authorization: <authorization>'
{
  "items": [
    {
      "id": 1,
      "workingTimeArrangementId": 1,
      "startsOn": "2023-12-25",
      "endsOn": "2023-12-25",
      "pattern": {
        "shape": "singleWeek",
        "monday": {
          "id": 1,
          "dayOffType": "off",
          "shifts": [
            "<any>"
          ],
          "workDuration": {}
        },
        "tuesday": {
          "id": 1,
          "dayOffType": "off",
          "shifts": [
            "<any>"
          ],
          "workDuration": {}
        },
        "wednesday": {
          "id": 1,
          "dayOffType": "off",
          "shifts": [
            "<any>"
          ],
          "workDuration": {}
        },
        "thursday": {
          "id": 1,
          "dayOffType": "off",
          "shifts": [
            "<any>"
          ],
          "workDuration": {}
        },
        "friday": {
          "id": 1,
          "dayOffType": "off",
          "shifts": [
            "<any>"
          ],
          "workDuration": {}
        },
        "saturday": {
          "id": 1,
          "dayOffType": "off",
          "shifts": [
            "<any>"
          ],
          "workDuration": {}
        },
        "sunday": {
          "id": 1,
          "dayOffType": "off",
          "shifts": [
            "<any>"
          ],
          "workDuration": {}
        }
      },
      "splitsHalfDays": true
    }
  ]
}

Headers

​
Authorization
string
required

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

Path Parameters

​
workingTimeArrangementId
integer
required

The unique identifier of the Working Time Arrangement.

Required range: x >= 0

Query Parameters

​
limit
integer
default:10

Number of items per page

Required range: 0 <= x <= 100
​
page
string

Next page token

Examples:

"next_token&fields.root=next"

"2"

​
fields.root
enum<string>

Include collection properties.

Available options:
count
​
sort
enum<string>
default:-startsOn

Sort items by a property.

Available options:
-startsOn

Response

OK

​
items
The Collective Schedule resource (named workCycle on the interface) · object[]
⌘I