Calendar API

/freeBusy

POST

/freeBusy

freebusy

Returns free/busy information for a set of calendars.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://www.googleapis.com/calendar/v3/freeBusy' \
--header 'Content-Type: application/json' \
--data-raw ''

Response Example

{
  "calendars": {
    "property1": {
      "busy": [
        {
          "end": "2019-08-24T14:15:22Z",
          "start": "2019-08-24T14:15:22Z"
        }
      ],
      "errors": [
        {
          "domain": "string",
          "reason": "string"
        }
      ]
    },
    "property2": {
      "busy": [
        {
          "end": "2019-08-24T14:15:22Z",
          "start": "2019-08-24T14:15:22Z"
        }
      ],
      "errors": [
        {
          "domain": "string",
          "reason": "string"
        }
      ]
    }
  },
  "groups": {
    "property1": {
      "calendars": [
        "string"
      ],
      "errors": [
        {
          "domain": "string",
          "reason": "string"
        }
      ]
    },
    "property2": {
      "calendars": [
        "string"
      ],
      "errors": [
        {
          "domain": "string",
          "reason": "string"
        }
      ]
    }
  },
  "kind": "calendar#freeBusy",
  "timeMax": "2019-08-24T14:15:22Z",
  "timeMin": "2019-08-24T14:15:22Z"
}

Request

Body Params application/json

calendarExpansionMax

integer <int32>

optional

Maximal number of calendars for which FreeBusy information is to be provided. Optional. Maximum value is 50.

groupExpansionMax

integer <int32>

optional

Maximal number of calendar identifiers to be provided for a single group. Optional. An error is returned for a group with more members than this value. Maximum value is 100.

items

array[object (FreeBusyRequestItem) {1}]

optional

List of calendars and/or groups to query.

string

optional

The identifier of a calendar or a group.

timeMax

string <date-time>

optional

The end of the interval for the query formatted as per RFC3339.

timeMin

string <date-time>

optional

The start of the interval for the query formatted as per RFC3339.

timeZone

string

optional

Time zone used in the response. Optional. The default is UTC.

Default:

UTC

Examples

Responses

🟢200Successful response

application/json

Body

calendars

object

optional

List of free/busy information for calendars.

Additional properties

object (FreeBusyCalendar)

optional

Free/busy expansions for a single calendar.

groups

object

optional

Expansion of groups.

Additional properties

object (FreeBusyGroup)

optional

List of calendars that are members of this group.

kind

string

optional

Type of the resource ("calendar#freeBusy").

Default:

calendar#freeBusy

timeMax

string <date-time>

optional

The end of the interval.

timeMin

string <date-time>

optional

The start of the interval.

Modified at 2023-08-15 05:59:47

/colors

/users/me/calendarList