---
title: "GET /calendar"
method: GET
path: "/calendar"
tags: ["calendar"]
---

# GET /calendar

`GET /calendar`

## Request

- Base URL: `https://www.weclapp.com/api/nullapi/v2`
- URL: `https://www.weclapp.com/api/nullapi/v2/calendar`
- Auth: API key in header `AuthenticationToken`
- TypeScript: <https://skmtc.dev/weclapp/apis/weclapp-api/docs/calendar/get.ts> (a function with typed inputs; its response is checked against the schema)

query calendar

## Query parameters

- `page` integer
- `pageSize` integer
- `sort` string

## Response `200`

calendar response

- object
  - `result` Calendar[]
    - `id` string
    - `version` string
    - `caldavAccountId` string
    - `calendarColor` string, required
    - `calendarKey` string
    - `calendarSharingPermissions` CalendarSharingPermissions[]
      - `id` string
      - `version` string
      - `createdDate` integer
      - `lastModifiedDate` integer
      - `permissionType` 'ADMIN' | 'READ' | 'READ_WRITE'
      - `userId` string
    - `createdDate` integer
    - `lastEventsSyncToken` string
    - `lastModifiedDate` integer
    - `mailAccountId` string
    - `name` string, required
    - `ownerId` string
    - `sharePrivateEvents` boolean
    - `synchronize` boolean

## Other responses

- `default`: error response

## Changes

- **2022-06-29** `a926aad6dc0c`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/weclapp/apis/weclapp-api/changes/calendar/get.md)

---

[API](https://skmtc.dev/weclapp/apis/weclapp-api.md) - [All operations](https://skmtc.dev/weclapp/apis/weclapp-api/llms.txt) - [OpenAPI document](https://skmtc.dev/weclapp/apis/weclapp-api/revisions/0e021229755d?raw)
