---
title: "Return calendars visible to the current user"
method: GET
path: "/v2/org/{orgId}/calendar"
tags: ["calendar"]
---

# Return calendars visible to the current user

`GET /v2/org/{orgId}/calendar`

## Path parameters

- `orgId` string, required

## Query parameters

- `calendarIds` string
- `limit` integer
- `returnAccess` string
- `status` 'ACTIVE' | 'INACTIVE'

## Response `200`

successful operation

- ResultsCalendar
  - `data` Calendar[], required
    - `id` string, required — globally unique id
    - `orgId` string — parent organization id
    - `type` 'ANNIVERSARY' | 'BIRTHDAY' | 'COMP_REVIEW' | 'REVIEW' | 'SURVEY' | 'TASK' | 'TIMEOFF' | 'START_DATE' | 'END_DATE' | 'CUSTOM' | 'HOLIDAY', required — type of calendar
    - `label` string, required — human-readable label for calendar
    - `description` string
    - `color` string, required
    - `imagePath` string
    - `emoji` string — emoji, if an emoji is used to represent the calendar
    - `sensitive` 'GLOBAL' | 'ORG' | 'SENSITIVE' | 'PERSONAL' | 'MANAGER' | 'HIGH' | 'PRIVATE', required — base sensitivity of this calendar and entities in it -- should be PRIVATE, ORG or HIGH
    - `shareAccess` ShareAccess[] — list of users and groups who have the content shared with them
      - `access` 'NONE' | 'LIMITED_READ' | 'LIMITED_WRITE' | 'STANDARD_READ' | 'STANDARD_WRITE' | 'COMPENSATION_READ' | 'FULL_READ' | 'COMP_PLANNING_PARTICIPANT' | 'COMPENSATION_WRITE' | 'WRITE' | 'COMPENSATION_OWNER' | 'OWNER', required — access permission level
      - `userId` string — user id
      - `groupId` string — group id
      - `fields` string — fields
    - `status` 'ACTIVE' | 'INACTIVE', required — whether the calendar is active or not
    - `eligibility` CalendarEligibility
      - `filter` string — CQL filter selecting the people this calendar applies to; blank matches everyone
      - `includePersonIds` string[] — personIds always included, regardless of the filter
      - `excludePersonIds` string[] — personIds always excluded, even if they match the filter
    - `createId` string — created by user id
    - `createBehalfId` string — created on behalf of user id
    - `createAttribution` Attribution
      - `principalUserId` string
      - `agentUserIds` string[]
      - `eventId` string
      - `aiChatId` string
      - `aiToolUseId` string
      - `channel` 'WEB' | 'MOBILE' | 'SLACK' | 'TEAMS' | 'MCP'
    - `createAt` string — created timestamp
    - `updateId` string — last updated by user id
    - `updateBehalfId` string — last updated on behalf of user id
    - `updateAttribution` Attribution
      - `principalUserId` string
      - `agentUserIds` string[]
      - `eventId` string
      - `aiChatId` string
      - `aiToolUseId` string
      - `channel` 'WEB' | 'MOBILE' | 'SLACK' | 'TEAMS' | 'MCP'
    - `updateAt` string — last updated timestamp
    - `deleteId` string — deleted by user id
    - `deleteBehalfId` string — deleted on behalf of user id
    - `deleteAttribution` Attribution
      - `principalUserId` string
      - `agentUserIds` string[]
      - `eventId` string
      - `aiChatId` string
      - `aiToolUseId` string
      - `channel` 'WEB' | 'MOBILE' | 'SLACK' | 'TEAMS' | 'MCP'
    - `deleteAt` string — deleted timestamp
    - `isBuiltIn` boolean, required
  - `next` string
  - `access` ResultsAccess[]
    - `ids` string[]
    - `allowed` AccessAction[], required
      - `action` string, required
      - `fields` string[]
      - `types` string[]

## Other responses

- `400` — bad request
- `401` — not authorized
- `404` — not found

---

[API](https://skmtc.net/charthop/apis/charthop-api.md) · [All operations](https://skmtc.net/charthop/apis/charthop-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/charthop/charthop-api/versions/50a1edd6b27e/schema)