Free Busy

The Free Busy API allows you to get the free/busy information for a set of calendars.

POST/v1/freeBusy/:endUserAccountId

Get Free Busy Slots

This endpoint retrieves the free/busy information for a set of calendars associated with an End User Account.

Path parameters

Name
endUserAccountId
Type
string
Description
The unique identifier of the End User Account to retrieve.

Request body parameters

Name
startDateTime
Type
string
Description
ISO 8601 date-time representing the start of the time range to retrieve free/busy information for. (Required)
Name
endDateTime
Type
string
Description
ISO 8601 date-time representing the end of the time range to retrieve free/busy information for. (Required)
Name
timeZone
Type
string
Description
Display all dates in the specified time zone. (Required)
Name
calendarIds
Type
string[]
Description
Calendar IDs to retrieve free/busy information for. (Required)

Request

POST

/v1/freeBusy/:endUserAccountId

curl -X POST https://api.onecalunified.com/api/v1/freeBusy/:endUserAccountId \
  -H "Content-Type: application/json" \
  -H "x-api-key: {apiKey}"
  -d '{"startDateTime": "2025-01-01T00:00:00Z", "endDateTime": "2025-01-02T00:00:00Z", "timeZone": "Europe/Tirane", "calendarIds": ["shared_calendar_1@group.calendar.google.com"]}'

Response

  [
    {
      "calendarId": "shared_calendar_1@group.calendar.google.com",
      "busySlots": [
        {
          "start": {
            "dateTime": "2025-08-13T02:00:00+02:00",
            "timeZone": "Europe/Rome"
          },
          "end": {
            "dateTime": "2025-08-14T02:00:00+02:00",
            "timeZone": "Europe/Rome"
          }
        }
      ]
    }
  ]