list_calendars

This reference is generated from the published tool contract.

Behavior and boundaries

Lists the calendars from connected Google, Microsoft 365 and CalDAV accounts that this assistant may use, with id, name, provider, time zone and whether each is read-only. When known, providerPreset identifies the CalDAV service (for example apple); do not treat all CalDAV calendars as Apple. Use the ids with list_events, search_events, find_available_times and the event tools. Calendars the user has not made available to this assistant are not listed; the result reports how many accounts were excluded and why. If the workspace’s plan limits the number of calendars per assistant, tarifHinweis says so.

Permissions

Granted scopes, accounts, calendars and visibility rules limit access. Workspace administrators do not automatically gain access to other users’ accounts.

calendar:read

Consent and boundaries

Input

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Output

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "kalender": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "provider": {
            "type": "string"
          },
          "providerPreset": {
            "type": "string"
          },
          "color": {
            "type": "string"
          },
          "timeZone": {
            "type": "string"
          },
          "readOnly": {
            "type": "boolean"
          },
          "art": {
            "type": "string",
            "enum": [
              "arbeit",
              "persoenlich"
            ]
          }
        },
        "required": [
          "id",
          "name",
          "provider",
          "readOnly",
          "art"
        ],
        "additionalProperties": false
      }
    },
    "ausgeschlossen": {
      "type": "object",
      "properties": {
        "andereOrganisation": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "arbeitGesperrt": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "inaktivesKonto": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "tenantUnbekannt": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        }
      },
      "required": [
        "andereOrganisation",
        "arbeitGesperrt",
        "inaktivesKonto",
        "tenantUnbekannt"
      ],
      "additionalProperties": false
    },
    "tarifHinweis": {
      "type": "string"
    }
  },
  "required": [
    "kalender",
    "ausgeschlossen"
  ],
  "additionalProperties": false
}

Errors and retries

Check the tool result for errors. Do not blindly retry writes after a timeout. Check the current resource or send status first.

Error handling