Charthop

Charthop calendar API

The calendar API from Charthop — 10 operation(s) for calendar.

Documentation GitHub OpenAPI

Operations 16

GET /v1/org/{orgId}/calendar Return calendar entries in a given time period #

GET /v2/org/{orgId}/calendar Return calendars visible to the current user #

POST /v2/org/{orgId}/calendar Create a new calendar #

GET /v2/org/{orgId}/calendar-event Returns calendar events visible to the current user with exclusive end dates #

POST /v2/org/{orgId}/calendar-event Create a new calendar entry #

GET /v2/org/{orgId}/calendar-event/condensed Returns calendar events, condensed when there are too many of a single entry on a particular day #

GET /v2/org/{orgId}/calendar-event/icalendar Returns calendar events in iCalendar format #

POST /v2/org/{orgId}/calendar-event/import Import calendar events from CSV file #

GET /v2/org/{orgId}/calendar-event/import/download-template Download a CSV template for calendar event import #

GET /v2/org/{orgId}/calendar-event/{calendarEntryId} Return a particular calendar entry by id #

PATCH /v2/org/{orgId}/calendar-event/{calendarEntryId} Update an existing calendar entry #

DELETE /v2/org/{orgId}/calendar-event/{calendarEntryId} Delete a calendar entry #

GET /v2/org/{orgId}/calendar/{calendarId} Return a particular calendar by id #

PATCH /v2/org/{orgId}/calendar/{calendarId} Update an existing calendar #

DELETE /v2/org/{orgId}/calendar/{calendarId} Delete a calendar #

GET /v2/org/{orgId}/calendar/{calendarId}/events Returns calendar events visible to the current user in a calendar #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/charthop-calendar-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  description: REST API for ChartHop
  version: V1.0.0
  title: ChartHop access Calendar API
  contact:
    name: ChartHop
    url: https://www.charthop.com
    email: support@charthop.com
servers:
- url: https://localhost
- url: http://localhost
tags:
- name: calendar
paths:
  /v1/org/{orgId}/calendar:
    get:
      tags:
      - calendar
      summary: Return calendar entries in a given time period
      operationId: findCalendarEntries
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: start
        in: query
        description: Start date
        required: false
        schema:
          type: string
      - name: end
        in: query
        description: End date
        required: false
        schema:
          type: string
      - name: type
        in: query
        description: Type of calendar entries to retrieve (timeoff, anniversary, birthday)
        required: false
        schema:
          type: string
      - name: q
        in: query
        description: Query filter to filter for part of the organization
        required: false
        schema:
          type: string
      - name: format
        in: query
        description: Format to return data in
        required: false
        schema:
          type: string
      responses:
        '400':
          description: bad request
        '401':
          description: not authorized
        '404':
          description: not found
  /v2/org/{orgId}/calendar:
    get:
      tags:
      - calendar
      summary: Return calendars visible to the current user
      operationId: getCalendars
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: calendarIds
        in: query
        description: Calendar IDs to filter by, comma-separated
        required: false
        schema:
          type: string
      - name: limit
        in: query
        description: Number of results to return
        required: false
        schema:
          type: integer
          format: int32
      - name: returnAccess
        in: query
        description: 'Return access information -- pass a list of actions to check, for example: create,update,delete'
        required: false
        schema:
          type: string
      - name: status
        in: query
        description: Optional status to filter by
        required: false
        schema:
          type: string
          enum:
          - ACTIVE
          - INACTIVE
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultsCalendar'
        '400':
          description: bad request
        '401':
          description: not authorized
        '404':
          description: not found
    post:
      tags:
      - calendar
      summary: Create a new calendar
      operationId: createCalendar
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Created a new calendar
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Calendar'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCalendar'
        description: Calendar data to create
        required: true
  /v2/org/{orgId}/calendar-event:
    get:
      tags:
      - calendar
      summary: Returns calendar events visible to the current user with exclusive end dates
      operationId: findCalendarEntries
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: startDate
        in: query
        description: Date to get events from, inclusive
        required: true
        schema:
          type: string
          format: date
      - name: endDate
        in: query
        description: Date to get events until, inclusive
        required: true
        schema:
          type: string
          format: date
      - name: filter
        in: query
        description: Optional CQL filter to apply to employee events
        required: false
        schema:
          type: string
      - name: calendarIds
        in: query
        description: Calendar IDs to filter by, comma-separated
        required: false
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultsCalendarEntry'
        '400':
          description: bad request
        '401':
          description: not authorized
        '404':
          description: not found
    post:
      tags:
      - calendar
      summary: Create a new calendar entry
      operationId: createCalendarEntry
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Created
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCalendarEntry'
        description: Calendar entry data to create
        required: true
  /v2/org/{orgId}/calendar-event/condensed:
    get:
      tags:
      - calendar
      summary: Returns calendar events, condensed when there are too many of a single entry on a particular day
      operationId: findCalendarEntriesCondensed
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: startDate
        in: query
        description: Date to get events from, inclusive
        required: true
        schema:
          type: string
          format: date
      - name: endDate
        in: query
        description: Date to get events until, inclusive
        required: true
        schema:
          type: string
          format: date
      - name: filter
        in: query
        description: Optional CQL filter to apply to employee events
        required: false
        schema:
          type: string
      - name: calendarIds
        in: query
        description: Calendar IDs to filter by, comma-separated
        required: false
        schema:
          type: string
      - name: maxEntriesPerCalendarPerDay
        in: query
        description: Maximum number of individual entries to show for a particular calendar on any given day (default 6)
        required: false
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultsCalendarEntryCondensed'
        '400':
          description: bad request
        '401':
          description: not authorized
        '404':
          description: not found
  /v2/org/{orgId}/calendar-event/icalendar:
    get:
      tags:
      - calendar
      summary: Returns calendar events in iCalendar format
      operationId: getCalendarEntriesAsIcalendar
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: startDate
        in: query
        description: Date to get events from, inclusive
        required: true
        schema:
          type: string
          format: date
      - name: endDate
        in: query
        description: Date to get events until, inclusive
        required: true
        schema:
          type: string
          format: date
      - name: filter
        in: query
        description: Optional CQL filter to apply to employee events
        required: false
        schema:
          type: string
      - name: calendarIds
        in: query
        description: Calendar IDs to filter by, comma-separated
        required: false
        schema:
          type: string
      - name: label
        in: query
        description: Calendar label
        required: false
        schema:
          type: string
      responses:
        '400':
          description: bad request
        '401':
          description: not authorized
        '404':
          description: not found
  /v2/org/{orgId}/calendar-event/import:
    post:
      tags:
      - calendar
      summary: Import calendar events from CSV file
      operationId: importCsv
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: calendarId
        in: query
        description: Calendar id to import events into
        required: true
        schema:
          type: string
      - name: importFromProcessId
        in: query
        description: Import a file from another process, instead of directly uploading it
        required: false
        schema:
          type: string
      - name: parentProcessId
        in: query
        description: Parent process id to attach to
        required: false
        schema:
          type: string
      responses:
        '200':
          description: import started
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Process'
        '400':
          description: bad request
        '401':
          description: not authorized
        '403':
          description: permission denied
        '404':
          description: not found
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
  /v2/org/{orgId}/calendar-event/import/download-template:
    get:
      tags:
      - calendar
      summary: Download a CSV template for calendar event import
      operationId: downloadImportCsvTemplate
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      responses:
        '200':
          description: success
        '400':
          description: bad request
        '401':
          description: not authorized
        '404':
          description: not found
  /v2/org/{orgId}/calendar-event/{calendarEntryId}:
    get:
      tags:
      - calendar
      summary: Return a particular calendar entry by id
      operationId: getCalendarEntry
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: calendarEntryId
        in: path
        description: Calendar entry id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalendarEntry'
    patch:
      tags:
      - calendar
      summary: Update an existing calendar entry
      operationId: updateCalendarEntry
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: calendarEntryId
        in: path
        description: Calendar entry id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCalendarEntry'
        description: Calendar entry data to update
        required: true
    delete:
      tags:
      - calendar
      summary: Delete a calendar entry
      operationId: deleteCalendarEntry
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: calendarEntryId
        in: path
        description: Calendar entry id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
  /v2/org/{orgId}/calendar/{calendarId}:
    get:
      tags:
      - calendar
      summary: Return a particular calendar by id
      operationId: getCalendar
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: calendarId
        in: path
        description: Calendar id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Calendar'
    patch:
      tags:
      - calendar
      summary: Update an existing calendar
      operationId: updateCalendar
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: calendarId
        in: path
        description: Calendar id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCalendar'
        description: Calendar data to update
        required: true
    delete:
      tags:
      - calendar
      summary: Delete a calendar
      operationId: deleteCalendar
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: calendarId
        in: path
        description: Calendar id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
  /v2/org/{orgId}/calendar/{calendarId}/events:
    get:
      tags:
      - calendar
      summary: Returns calendar events visible to the current user in a calendar
      operationId: findEntriesByCalendarId
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: calendarId
        in: path
        description: Calendar id
        required: true
        schema:
          type: string
      - name: startDate
        in: query
        description: Date to get events from, inclusive
        required: false
        schema:
          type: string
          format: date
      - name: endDate
        in: query
        description: Date to get events until, inclusive
        required: false
        schema:
          type: string
          format: date
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultsCalendarEntry'
        '400':
          description: bad request
        '401':
          description: not authorized
        '404':
          description: not found
components:
  schemas:
    Attribution:
      type: object
      properties:
        principalUserId:
          type: string
          example: 588f7ee98f138b19220041a7
        agentUserIds:
          type: array
          items:
            type: string
            example: 588f7ee98f138b19220041a7
        eventId:
          type: string
          example: 588f7ee98f138b19220041a7
        aiChatId:
          type: string
          example: 588f7ee98f138b19220041a7
        aiToolUseId:
          type: string
        channel:
          type: string
          enum:
          - WEB
          - MOBILE
          - SLACK
          - TEAMS
          - MCP
    LogData:
      type: object
      required:
      - level
      - at
      - data
      properties:
        level:
          type: string
          enum:
          - INFO
          - WARN
          - ERROR
        at:
          type: string
          description: created timestamp
          example: '2017-01-24T13:57:52Z'
        message:
          type: string
        data:
          type: object
          additionalProperties:
            type: object
    ShareAccess:
      type: object
      required:
      - access
      properties:
        access:
          type: string
          description: access permission level
          enum:
          - NONE
          - LIMITED_READ
          - LIMITED_WRITE
          - STANDARD_READ
          - STANDARD_WRITE
          - COMPENSATION_READ
          - FULL_READ
          - COMP_PLANNING_PARTICIPANT
          - COMPENSATION_WRITE
          - WRITE
          - COMPENSATION_OWNER
          - OWNER
        userId:
          type: string
          description: user id
          example: 5887a7718f138b6a2a0041a7
        groupId:
          type: string
          description: group id
          example: 5887a7718f138b6a2a0041a7
        fields:
          type: string
          description: fields
          example: name,image,title
    CreateCalendarEntry:
      type: object
      required:
      - calendarId
      - label
      - from
      - until
      properties:
        orgId:
          type: string
          description: parent organization id
          example: 665f3ad1e47a82bf1d3d180b
        calendarId:
          type: string
          description: calendar to which this event pertains
          example: 665f3aabe88164e4ef6c3a22
        label:
          type: string
          description: human-readable label for event
        description:
          type: string
        from:
          type: string
          format: date
          description: start date for event (inclusive)
          example: '2024-02-29'
        until:
          type: string
          format: date
          description: end date for event (exclusive)
          example: '2024-04-01'
        entityType:
          type: string
          description: type of associated entity
          example: PERSON
          enum:
          - ACTION
          - AGREEMENT
          - AI_AGENT
          - AI_AGENT_MEMORY
          - AI_CHAT
          - AI_CONFIG
          - AI_CREDIT_LIMIT
          - AI_CREDIT_USAGE
          - AI_HINT
          - AI_PROMPT
          - APP
          - APP_CONFIG
          - APPROVAL_CHAIN
          - APPROVAL_CHAIN_STAGE
          - APPROVAL_DELEGATE
          - APPROVAL_REQUEST
          - ASSESSMENT
          - BUDGET
          - BUDGET_POOL
          - BUNDLE
          - CALENDAR
          - CALENDAR_ENTRY
          - CATEGORY
          - CATEGORY_SORT
          - CHANGE
          - COMMENT
          - COMP_BAND
          - COMP_REVIEW
          - CONTENT
          - CUSTOMER
          - DATA_VIEW
          - EXCHANGE_RATE
          - EMAIL_TEMPLATE
          - EVENT
          - FIELD
          - FILE
          - FORM
          - FORM_DRAFT
          - FORM_RESPONSE
          - GEOCODE
          - GROUP
          - GROUP_TYPE
          - GOAL
          - GOAL_PROGRESS
          - GOAL_TARGET
          - GOAL_TYPE
          - GUIDELINE
          - JOB
          - JOB_CODE
          - JOB_LEVEL
          - MEDIA
          - MESSAGE
          - MULTIPLIER
          - ORG
          - ORG_CONFIG
          - PERSON
          - PROFILE_TAB
          - POLICY
          - PROCESS
          - PRODUCT
          - QUERY_TOKEN
          - QUESTION
          - REPORT
          - REPORT_CHART
          - ROLE
          - SCENARIO
          - SIGNATURE
          - SIGNATURE_REQUEST
          - STOCK_GRANT
          - STOCK_PRICE
          - TABLE
          - TABLE_ROW
          - TASK_CONFIG
          - TEMPLATE
          - TASK
          - TOKEN
          - TIMEOFF
          - TIMEOFF_BALANCE_ADJUSTMENT
          - TIMEOFF_LEDGER_ENTRY
          - TIMEOFF_POLICY
          - TRANSCRIPT
          - USER
        entityId:
          type: string
          description: associated entity
          example: 665f6952552f7e3e5beea7c9
        personId:
          type: string
          description: person id for person-related calendar entries
          example: 665f6952552f7e3e5beea7c9
    UpdateCalendar:
      type: object
      properties:
        type:
          type: string
          description: type of calendar
          enum:
          - ANNIVERSARY
          - BIRTHDAY
          - COMP_REVIEW
          - REVIEW
          - SURVEY
          - TASK
          - TIMEOFF
          - START_DATE
          - END_DATE
          - CUSTOM
          - HOLIDAY
        label:
          type: string
          description: human-readable label for calendar
        description:
          type: string
        color:
          type: string
        imagePath:
          type: string
          pattern: ^[a-zA-Z0-9._/-]*$
        emoji:
          type: string
          description: emoji, if an emoji is used to represent the calendar
          example: 💥
          minItems: 0
          maxItems: 64
        sensitive:
          type: string
          description: base sensitivity of this calendar and entities in it -- should be PRIVATE, ORG or HIGH
          enum:
          - GLOBAL
          - ORG
          - SENSITIVE
          - PERSONAL
          - MANAGER
          - HIGH
          - PRIVATE
        shareAccess:
          type: array
          description: list of users and groups who have the content shared with them
          items:
            $ref: '#/components/schemas/ShareAccess'
        status:
          type: string
          description: whether the calendar is active or not
          enum:
          - ACTIVE
          - INACTIVE
    ResultsCalendar:
      type: object
      required:
      - data
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Calendar'
        next:
          type: string
        access:
          type: array
          items:
            $ref: '#/components/schemas/ResultsAccess'
    ResultsCalendarEntry:
      type: object
      required:
      - data
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CalendarEntry'
        next:
          type: string
        access:
          type: array
          items:
            $ref: '#/components/schemas/ResultsAccess'
    ResultsAccess:
      type: object
      required:
      - allowed
      properties:
        ids:
          type: array
          uniqueItems: true
          items:
            type: string
            example: 588f7ee98f138b19220041a7
        allowed:
          type: array
          uniqueItems: true
          items:
            $ref: '#/components/schemas/AccessAction'
    CalendarEntryCondensed:
      type: object
      required:
      - id
      - orgId
      - calendarId
      - calendarType
      - label
      - from
      - entryCount
      properties:
        id:
          type: string
          example: 588f7ee98f138b19220041a7
        orgId:
          type: string
          example: 588f7ee98f138b19220041a7
        calendarId:
          type: string
          example: 588f7ee98f138b19220041a7
        calendarType:
          type: string
          enum:
          - ANNIVERSARY
          - BIRTHDAY
          - COMP_REVIEW
          - REVIEW
          - SURVEY
          - TASK
          - TIMEOFF
          - START_DATE
          - END_DATE
          - CUSTOM
          - HOLIDAY
        label:
          type: string
        from:
          type: string
          format: date
        until:
          type: string
          format: date
        singleEntry:
          $ref: '#/components/schemas/CalendarEntry'
        entryCount:
          type: integer
          format: int32
    CalendarEntry:
      type: object
      required:
      - id
      - calendarId
      - label
      - from
      - until
      properties:
        id:
          type: string
          description: globally unique id, or zero-id if the entry is a virtual entry
          example: 665f68b537795e0cb768bb74
        orgId:
          type: string
          description: parent organization id
          example: 665f3ad1e47a82bf1d3d180b
        calendarId:
          type: string
          description: calendar to which this event pertains
          example: 665f3aabe88164e4ef6c3a22
        label:
          type: string
          description: human-readable label for event
        description:
          type: string
        from:
          type: string
          format: date
          description: start date for event (inclusive)
          example: '2024-02-29'
        until:
          type: string
          format: date
          description: end date for event (exclusive)
          example: '2024-04-01'
        entityType:
          type: string
          description: type of associated entity
          example: PERSON
          enum:
          - ACTION
          - AGREEMENT
          - AI_AGENT
          - AI_AGENT_MEMORY
          - AI_CHAT
          - AI_CONFIG
          - AI_CREDIT_LIMIT
          - AI_CREDIT_USAGE
          - AI_HINT
          - AI_PROMPT
          - APP
          - APP_CONFIG
          - APPROVAL_CHAIN
          - APPROVAL_CHAIN_STAGE
          - APPROVAL_DELEGATE
          - APPROVAL_REQUEST
          - ASSESSMENT
          - BUDGET
          - BUDGET_POOL
          - BUNDLE
          - CALENDAR
          - CALENDAR_ENTRY
          - CATEGORY
          - CATEGORY_SORT
          - CHANGE
          - COMMENT
          - COMP_BAND
          - COMP_REVIEW
          - CONTENT
          - CUSTOMER
          - DATA_VIEW
          - EXCHANGE_RATE
          - EMAIL_TEMPLATE
          - EVENT
          - FIELD
          - FILE
          - FORM
          - FORM_DRAFT
          - FORM_RESPONSE
          - GEOCODE
          - GROUP
          - GROUP_TYPE
          - GOAL
          - GOAL_PROGRESS
          - GOAL_TARGET
          - GOAL_TYPE
          - GUIDELINE
          - JOB
          - JOB_CODE
          - JOB_LEVEL
          - MEDIA
          - MESSAGE
          - MULTIPLIER
          - ORG
          - ORG_CONFIG
          - PERSON
          - PROFILE_TAB
          - POLICY
          - PROCESS
          - PRODUCT
          - QUERY_TOKEN
          - QUESTION
          - REPORT
          - REPORT_CHART
          - ROLE
          - SCENARIO
          - SIGNATURE
          - SIGNATURE_REQUEST
          - STOCK_GRANT
          - STOCK_PRICE
          - TABLE
          - TABLE_ROW
          - TASK_CONFIG
          - TEMPLATE
          - TASK
          - TOKEN
          - TIMEOFF
          - TIMEOFF_BALANCE_ADJUSTMENT
          - TIMEOFF_LEDGER_ENTRY
          - TIMEOFF_POLICY
          - TRANSCRIPT
          - USER
        entityId:
          type: string
          description: associated entity
          example: 665f6952552f7e3e5beea7c9
        personId:
          type: string
          description: person id for person-related calendar entries
          example: 665f6952552f7e3e5beea7c9
        createId:
          type: string
          description: created by user id
          example: 588f7ee98f138b19220041a7
        createBehalfId:
          type: string
          description: created on behalf of user id
          example: 588f7ee98f138b19220041a7
        createAttribution:
          $ref: '#/components/schemas/Attribution'
        createAt:
          type: string
          description: created timestamp
          example: '2017-01-24T13:57:52Z'
        updateId:
          type: string
          description: last updated by user id
          example: 588f7ee98f138b19220041a7
        updateBehalfId:
          type: string
          description: last updated on behalf of user id
          example: 588f7ee98f138b19220041a7
        updateAttribution:
          $ref: '#/components/schemas/Attribution'
        updateAt:
          type: string
          description: last updated timestamp
          example: '2017-01-24T13:57:52Z'
        deleteId:
          type: string
          description: deleted by user id
          example: 588f7ee98f138b19220041a7
        deleteBehalfId:
          type: string
          description: deleted on behalf of user id
          example: 588f7ee98f138b19220041a7
        deleteAttribution:
          $ref: '#/components/schemas/Attribution'
        deleteAt:
          type: string
          description: deleted timestamp
          example: '2017-01-24T13:57:52Z'
    ResultsCalendarEntryCondensed:
      type: object
      required:
      - data
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CalendarEntryCondensed'
        next:
          type: string
        access:
          type: array
          items:
            $ref: '#/components/schemas/ResultsAccess'
    CreateCalendar:
      type: object
      required:
      - type
      - label
      - color
      - sensitive
      - status
      properties:
        type:
          type: string
          description: type of calendar
          enum:
          - ANNIVERSARY
          - BIRTHDAY
          - COMP_REVIEW
          - REVIEW
          - SURVEY
          - TASK
          - TIMEOFF
          - START_DATE
          - END_DATE
          - CUSTOM
          - HOLIDAY
        label:
          type: string
          description: human-readable label for calendar
        description:
          type: string
        color:
          type: string
        imagePath:
          type: string
          pattern: ^[a-zA-Z0-9._/-]*$
        emoji:
          type: string
          description: emoji, if an emoji is used to represent the calendar
          example: 💥
          minItems: 0
          maxItems: 64
        sensitive:
          type: string
          description: base sensitivity of this calendar and entities in it -- should be PRIVATE, ORG or HIGH
          enum:
          - GLOBAL
          - ORG
          - SENSITIVE
          - PERSONAL
          - MANAGER
          - HIGH
          - PRIVATE
        shareAccess:
          type: array
          description: list of users and groups who have the content shared with them
          items:
            $ref: '#/components/schemas/ShareAccess'
        status:
          type: string
          description: whether the calendar is active or not
          enum:
          - ACTIVE
          - INACTIVE
    UpdateCalendarEntry:
      type: object
      properties:
        label:
          type: string
          description: human-readable label for event
        description:
          type: string
        from:
          type: string
          format: date
          description: start date for event (inclusive)
          example: '2024-02-29'
        until:
          type: string
          format: date
          description: end date for event (exclusive)
          example: '2024-04-01'
    Calendar:
      type: object
      required:
      - id
      - type
      - label
      - color
      - sensitive
      - status
      - isBuiltIn
      properties:
        id:
          type: string
          description: globally unique id
          example: 665f3aabe88164e4ef6c3a22
        orgId:
          type: string
          description: parent organization id
          example: 665f3ad1e47a82bf1d3d180b
        type:
          type: string
          description: type of calendar
          enum:
          - ANNIVERSARY
          - BIRTHDAY
          - COMP_REVIEW
          - REVIEW
          - SURVEY
          - TASK
          - TIMEOFF
          - START_DATE
          - END_DATE
          - CUSTOM
          - HOLIDAY
        label:
          type: string
          description: human-readable label for calendar
        description:
          type: string
        color:
          type: string
        imagePath:
          type: string
          pattern: ^[a-zA-Z0-9._/-]*$
        em

# --- truncated at 32 KB (38 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/charthop/refs/heads/main/openapi/charthop-calendar-api-openapi.yml