IntegrationsGoogle workspaceActions
List Google Calendar events
List events on a calendar the connected principal can access.
calendar.events.list · Google Workspace · v1
Details
Scopes
https://www.googleapis.com/auth/calendar.events.readonly
Input
| Name | Type | Required | Constraints |
|---|---|---|---|
(root) | object | Yes | additionalProperties false |
calendar_id | string | No | minLength 1; maxLength 256 |
page_size | integer | No | minimum 1; maximum 250 |
page_token | string | No | minLength 1; maxLength 512 |
time_min | string | No | minLength 10; maxLength 64 |
time_max | string | No | minLength 10; maxLength 64 |
q | string | No | maxLength 512 |
Output
| Name | Type | Required | Constraints |
|---|---|---|---|
(root) | object | Yes | additionalProperties false |
events | array<object> | Yes | maxItems 250 |
events[] | object | Yes | additionalProperties false |
events[].id | string | Yes | maxLength 1024 |
events[].status | string | Yes | maxLength 64 |
events[].summary | string | No | maxLength 1024 |
events[].description | string | No | maxLength 8192 |
events[].location | string | No | maxLength 1024 |
events[].start | object | No | additionalProperties false; oneOf branch 1: required date_time / branch 2: required date |
events[].start.date_time | string | No | minLength 10; maxLength 64 |
events[].start.date | string | No | minLength 10; maxLength 10; pattern ^\d{4}-\d{2}-\d{2}$ |
events[].start.time_zone | string | No | minLength 1; maxLength 64 |
events[].end | object | No | additionalProperties false; oneOf branch 1: required date_time / branch 2: required date |
events[].end.date_time | string | No | minLength 10; maxLength 64 |
events[].end.date | string | No | minLength 10; maxLength 10; pattern ^\d{4}-\d{2}-\d{2}$ |
events[].end.time_zone | string | No | minLength 1; maxLength 64 |
events[].html_link | string | No | maxLength 2048 |
next_page_token | string | No | maxLength 512 |
Raw schema
Input
{
"type": "object",
"additionalProperties": false,
"properties": {
"calendar_id": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"page_size": {
"type": "integer",
"minimum": 1,
"maximum": 250
},
"page_token": {
"type": "string",
"minLength": 1,
"maxLength": 512
},
"time_min": {
"type": "string",
"minLength": 10,
"maxLength": 64
},
"time_max": {
"type": "string",
"minLength": 10,
"maxLength": 64
},
"q": {
"type": "string",
"maxLength": 512
}
}
}Output
{
"type": "object",
"additionalProperties": false,
"properties": {
"events": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"maxLength": 1024
},
"status": {
"type": "string",
"maxLength": 64
},
"summary": {
"type": "string",
"maxLength": 1024
},
"description": {
"type": "string",
"maxLength": 8192
},
"location": {
"type": "string",
"maxLength": 1024
},
"start": {
"type": "object",
"additionalProperties": false,
"properties": {
"date_time": {
"type": "string",
"minLength": 10,
"maxLength": 64
},
"date": {
"type": "string",
"minLength": 10,
"maxLength": 10,
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"time_zone": {
"type": "string",
"minLength": 1,
"maxLength": 64
}
},
"oneOf": [
{
"required": [
"date_time"
]
},
{
"required": [
"date"
]
}
]
},
"end": {
"type": "object",
"additionalProperties": false,
"properties": {
"date_time": {
"type": "string",
"minLength": 10,
"maxLength": 64
},
"date": {
"type": "string",
"minLength": 10,
"maxLength": 10,
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"time_zone": {
"type": "string",
"minLength": 1,
"maxLength": 64
}
},
"oneOf": [
{
"required": [
"date_time"
]
},
{
"required": [
"date"
]
}
]
},
"html_link": {
"type": "string",
"maxLength": 2048
}
},
"required": [
"id",
"status"
]
},
"maxItems": 250
},
"next_page_token": {
"type": "string",
"maxLength": 512
}
},
"required": [
"events"
]
}