Sign in
calendar

List calendars

Changed on

ViewSet for managing calendars.

get/calendar{format}

Request

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

Path parameters

format'.json' 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
include_inactiveboolean

When true, include inactive (soft-deleted) calendars (visibility=inactive). Defaults to false.

include_unlistedboolean

When true, include unlisted calendars (visibility=unlisted) in the response. Unlisted calendars are hidden from booking queries but still synced. Defaults to false.

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

ownerstring

Scope the listing to a calendar owner. Pass 'me' to return only the authenticated user's own calendars. Pass a numeric user id to return that user's calendars — allowed for organization admins only; non-admins receive 403. When omitted, admins see all organization calendars while non-admins are restricted to their own.

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
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

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Changes

  • c8034a17551bRevision changes
    • ○

      added the new optional query request parameter owner

  • 408c86eb5933Revision changes
    • ▲

      the response property // became optional for the status

    • ○

      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

    • ○

      the response required property // became not read-only for the status