v1

latestOpenAPI 3.0.12026-07-243686491.1 MB

Schedules

Retrieve a list of schedules.

Required scope: schedules:read </br>Organization authorization: supported

get/api/v1/schedules

Query parameters

teamIdinteger

Filter by team id. When omitted, returns all schedules owned by the consumer's operator.

searchstring

Free-text search filter by schedule name. Max 200 characters.

pageinteger

Page number to retrieve (starts with 0)

perPageinteger

Number of items per page (between 1 and 100, default 10)

Response

List of schedules that match the criteria

Example response

{
  "data": [
    {
      "id": 42,
      "teamId": 12,
      "name": "Weekday Hours",
      "timezone": "Europe/Copenhagen",
      "priceGroupId": 99,
      "entryCount": 5,
      "entries": [
        {
          "id": 12,
          "from": "08:00:00",
          "to": "18:00:00",
          "priceGroupId": 42
        }
      ],
      "createdAt": "2023-03-16T15:37:23Z",
      "updatedAt": "2023-03-16T15:37:23Z"
    }
  ]
}