---
updatedAt: 2025-12-04T09:06:30.000Z
agentTools:
projectIndex: https://developers.getknit.dev/llms.txt
---
# List all events
The List Calendar Events API retrieves events from a specified calendar within a given time range, supporting date filtering and pagination.
## Supported Apps
Here is the list of apps that supports this API
> 🚧 Use Get a single event API for additional details
>
> This API may not return all fields defined in the response schema; for additional details, use the Get a single event API
# OpenAPI definition
```json
{
"openapi": "3.1.0",
"info": {
"title": "base-api",
"version": "1.0"
},
"servers": [
{
"url": "https://api.getknit.dev/v1.0"
}
],
"components": {
"securitySchemes": {
"sec0": {
"type": "apiKey",
"in": "header",
"name": "Authorization",
"x-bearer-format": "bearer"
},
"sec1": {
"type": "apiKey",
"in": "header",
"name": "X-Knit-Integration-Id"
}
}
},
"security": [
{
"sec0": [],
"sec1": []
}
],
"paths": {
"/calendar.event.list": {
"get": {
"summary": "List all events",
"description": "The List Calendar Events API retrieves events from a specified calendar within a given time range, supporting date filtering and pagination.",
"operationId": "list-all-events",
"parameters": [
{
"name": "calendarId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "startDateTime",
"in": "query",
"description": "Filters events that start on or after the specified datetime in ISO 8601 UTC format (yyyy-MM-dd'T'HH:mm:ss'Z').\nDefaults to the date on which the API request is made.",
"schema": {
"type": "string"
}
},
{
"name": "endDateTime",
"in": "query",
"description": "Filters events that end on or before the specified datetime in ISO 8601 UTC format (yyyy-MM-dd'T'HH:mm:ss'Z').\nDefaults to one month from the date the API request is made.",
"schema": {
"type": "string"
}
},
{
"name": "pageSize",
"in": "query",
"description": "pageSize is required to control size of results",
"schema": {
"type": "integer",
"format": "int32",
"default": 50
}
},
{
"name": "pageToken",
"in": "query",
"description": "pageToken fetches additional records; leave empty on the first request and use the next token from the previous response if more records exist.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": {
"success": true,
"data": {
"events": [
{
"id": "event123",
"title": "Team Meeting",
"description": "Monthly team sync",
"location": "Conference Room 1",
"startTime": "2024-12-20T10:00:00Z",
"endTime": "2024-12-20T11:00:00Z",
"allDay": false,
"recurrence": [
{
"pattern": "FREQ=WEEKLY;BYDAY=MO",
"exDate": "2024-12-25T10:00:00Z"
}
],
"attendees": [
{
"id": "attendee123",
"name": "John Doe",
"email": "john.doe@example.com",
"responseStatus": "ACCEPTED|DECLINED|TENTATIVE|NEEDS_ACTION"
},
{
"id": "attendee124",
"name": "Jane Smith",
"email": "jane.smith@example.com",
"responseStatus": "ACCEPTED|DECLINED|TENTATIVE|NEEDS_ACTION"
}
],
"organizer": {
"id": "organizer123",
"email": "organizer@example.com",
"name": "Alice Johnson"
},
"reminders": [
{
"type": "EMAIL|POP_UP",
"minutes": "10"
},
{
"type": "POP_UP",
"minutes": "30"
}
],
"status": "CONFIRMED|CANCELLED|TENTATIVE",
"visibility": "public",
"color": "blue",
"createdDateTime": "2024-12-01T08:00:00Z",
"lastModifiedDateTime": "2024-12-10T09:00:00Z",
"calendarId": "calendar123",
"masterEventId": "masterEvent123",
"conferenceDetails": {
"provider": "GOOGLE_MEET|MS_TEAMS|ZOOM",
"url": "https://meet.google.com/example",
"passCode": "123456",
"phoneNumber": "+1234567890"
}
}
]
},
"pageToken": "djkwlhfwekr102939"
}
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": true,
"default": true
},
"data": {
"type": "object",
"properties": {
"events": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "event123"
},
"title": {
"type": "string",
"example": "Team Meeting"
},
"description": {
"type": "string",
"example": "Monthly team sync"
},
"location": {
"type": "string",
"example": "Conference Room 1"
},
"startTime": {
"type": "string",
"example": "2024-12-20T10:00:00Z"
},
"endTime": {
"type": "string",
"example": "2024-12-20T11:00:00Z"
},
"allDay": {
"type": "boolean",
"example": false,
"default": true
},
"recurrence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"pattern": {
"type": "string",
"example": "FREQ=WEEKLY;BYDAY=MO"
},
"exDate": {
"type": "string",
"example": "2024-12-25T10:00:00Z"
}
}
}
},
"attendees": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "attendee123"
},
"name": {
"type": "string",
"example": "John Doe"
},
"email": {
"type": "string",
"example": "john.doe@example.com"
},
"responseStatus": {
"type": "string",
"example": "ACCEPTED|DECLINED|TENTATIVE|NEEDS_ACTION"
}
}
}
},
"organizer": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "organizer123"
},
"email": {
"type": "string",
"example": "organizer@example.com"
},
"name": {
"type": "string",
"example": "Alice Johnson"
}
}
},
"reminders": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "EMAIL|POP_UP"
},
"minutes": {
"type": "string",
"example": "10"
}
}
}
},
"status": {
"type": "string",
"example": "CONFIRMED|CANCELLED|TENTATIVE"
},
"visibility": {
"type": "string",
"example": "public"
},
"color": {
"type": "string",
"example": "blue"
},
"createdDateTime": {
"type": "string",
"example": "2024-12-01T08:00:00Z"
},
"lastModifiedDateTime": {
"type": "string",
"example": "2024-12-10T09:00:00Z"
},
"calendarId": {
"type": "string",
"example": "calendar123"
},
"masterEventId": {
"type": "string",
"example": "masterEvent123"
},
"conferenceDetails": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"example": "GOOGLE_MEET|MS_TEAMS|ZOOM"
},
"url": {
"type": "string",
"example": "https://meet.google.com/example"
},
"passCode": {
"type": "string",
"example": "123456"
},
"phoneNumber": {
"type": "string",
"example": "+1234567890"
}
}
}
}
}
}
}
},
"pageToken": {
"type": "string",
"example": "djkwlhfwekr102939"
}
}
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"success\": false,\n \"error\": {\n \"msg\": \"descriptive error message\"\n }\n}"
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": false,
"default": true
},
"error": {
"type": "object",
"properties": {
"msg": {
"type": "string",
"example": "descriptive error message"
}
}
}
}
}
}
}
}
},
"deprecated": false
}
}
},
"x-readme": {
"headers": [],
"explorer-enabled": true,
"proxy-enabled": true
},
"x-readme-fauxas": true
}
```