List Collective Schedules from a Working Time Arrangement

This is a beta feature. You may not benefit from this feature. Working-time-arrangements are the replacement for the workcycles. If this feature has not been deployed on your environment, please contact our support.

Get the list of Collective Schedules from a Working Time Arrangement by id

GET /schedule/api/working-time-arrangements/{workingTimeArrangementId}/collective-schedules

List Collective Schedules from a Working Time Arrangement

cURL

curl --request GET \
  --url https://{host}/schedule/api/working-time-arrangements/{workingTimeArrangementId}/collective-schedules \
  --header 'Authorization: <authorization>'

200

{
  "items": [
    {
      "id": 1,
      "workingTimeArrangementId": 1,
      "pattern": {
        "shape": "singleWeek"
      },
      "splitsHalfDays": true,
      "startsOn": "2023-12-25",
      "endsOn": "2023-12-25"
    }
  ]
}

Headers

Authorization · string · required

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

Path Parameters

workingTimeArrangementId · integer<int32> · 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

200

application/json

OK

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

Show child attributes