Sign in
calendar

Get unavailable time windows

Changed on

Get unavailable time windows for a calendar within a specified date range.

get/calendar/{id}/unavailable-windows/

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP bearer
    • API key in cookie sessionid

Path parameters

idstring required

Query parameters

calendar_type'bundle' | 'personal' | 'resource' | 'virtual'

Filter by calendar type (e.g. resource)

  • personal - Personal Calendar
  • resource - Resource Calendar
  • virtual - Virtual Calendar
  • bundle - Bundle Calendar
end_datetimestring required

End datetime in ISO format (YYYY-MM-DDTHH:MM:SS)

provider'apple' | 'google' | 'ics' | 'internal' | 'microsoft'

Filter by provider (internal = manual, others = synced)

  • internal - Internal Calendar
  • google - Google Calendar
  • microsoft - Microsoft Outlook Calendar
  • apple - Apple Calendar
  • ics - ICS
start_datetimestring required

Start datetime in ISO format (YYYY-MM-DDTHH:MM:SS)

sync_enabledboolean

Filter by whether provider sync is enabled

Headers

X-Organization-Idstring

Selects the active organization for this request. Optional for callers that belong to exactly one active organization — the single membership is resolved implicitly. Required when the caller has two or more active memberships; omitting it in that case returns 400. If the header names an organization the caller is not an active member of, the server returns 403.

Response

idinteger required
reasonstring required
start_timestring date-time required
end_timestring date-time required
reason_descriptionstring required

Changes

  • 408c86eb5933Revision changes
    • ○

      added the new optional query request parameter calendar_type

    • ○

      added the new optional query request parameter provider

    • ○

      added the new optional query request parameter sync_enabled

  • 3ae1198a9fcdRevision changes
    • ○

      added the new optional header request parameter X-Organization-Id