v1

latestOpenAPI 3.0.02026-07-17121287546.7 KB

Schedules

Get default schedule

Get the default schedule of the authenticated user.

<Note>Please make sure to pass in the cal-api-version header value as mentioned in the Headers section. Not passing the correct value will default to an older version of this endpoint.</Note>

get/v2/schedules/default

Headers

Authorizationstring required

value must be Bearer <token> where <token> is api key prefixed with cal_ or managed user access token

cal-api-versionstring required

Must be set to 2024-06-11. If not set to this value, the endpoint will default to an older version.

Response

status'success' | 'error' required

Example response

{
  "status": "success",
  "data": {
    "id": 254,
    "ownerId": 478,
    "name": "Catch up hours",
    "timeZone": "Europe/Rome",
    "availability": [
      {
        "days": [
          "Monday",
          "Tuesday"
        ],
        "startTime": "17:00",
        "endTime": "19:00"
      },
      {
        "days": [
          "Wednesday",
          "Thursday"
        ],
        "startTime": "16:00",
        "endTime": "20:00"
      }
    ],
    "isDefault": true,
    "overrides": [
      {
        "date": "2024-05-20",
        "startTime": "18:00",
        "endTime": "21:00"
      }
    ]
  }
}