LogoLogo
Log in
  • Introduction
    • Welcome
    • Quick Start
      • Sign up for a Cal.com account
      • Complete your onboarding
      • Self-hosting
        • Installation
          • Ultimate
          • Platform
            • Get access to the API
            • API submodule
        • Install apps
          • Google
          • Microsoft
          • Zoom
          • Daily
          • HubSpot
          • Stripe
          • Sendgrid
          • Twilio
        • E2E testing
        • Upgrading
        • Docker
        • Vercel
        • Database migrations
        • SSO setup
  • Core Features
    • Event types
      • Secret events
      • Location of the event
      • Availability schedule
      • Multiple durations
      • Event buffer
      • Custom time-slot intervals
      • Custom event name in the booking
      • Minimum notice
      • Booking frequency
      • Limit future bookings
      • Add events to calendar
      • Additional inputs
      • Requires confirmation
      • Hide notes in calendar
      • Require additional notes
      • Booking success URL
      • Single use private links
      • Offer seats
      • Recurring events
      • Disable guests
    • Bookings
      • Paid bookings
    • Availability
      • Multiple time slots per day
      • Date overrides
      • Multiple schedules
    • App Store
      • Apps
        • Calendar apps
        • Video apps
        • Payment apps
        • Workflow apps
        • Analytics apps
        • Web3 apps
        • Miscellaneous apps
    • Webhooks
    • Embed
      • Install with JavaScript
      • Install with React
      • Set up your embed
    • New Docs Embed
      • Adding embed to your webpage
      • Embed Snippet Generator
      • Embed events
      • Embed instructions
      • Adding slots to your email
    • Dynamic group links
    • Customization
    • i18n Internationalization
  • Enterprise Features
    • Teams
      • Team workflows
      • Round-robin scheduling
      • Collective events
      • Advanced routing forms
    • Workflows
    • API
      • Quick start
        • Testing API locally
        • Hosted API through Cal.com
      • Authentication
      • Errors
      • Rate limits
      • Versioning
      • Types
      • API reference
        • Attendees
        • Availabilities
        • Booking References
        • Bookings
        • Custom inputs
        • Destination calendars
        • Event types
        • Memberships
        • Payments
        • Schedules
        • Selected calendars
        • Teams
        • Users
        • Webhooks
    • Admin
  • Knowledgebase
    • Glossary
  • How To Guides
    • Acquire and manage a license key
    • Adding your first app
    • Creating a secret event type
    • Creating your first event type
    • How to add a location to your event type
    • How to add custom CSS
    • How to build an app
      • Build a greeter app
    • How to connect apple calendar with calcom
    • How to troubleshoot symbolic link issues on Windows
    • How to set buffer time
    • How to set up requires confirmation
    • How to set time-slot intervals
    • How to set up an event type to receive payments
    • How to test API in a local instance
    • How to use open-source scheduling infrastructure with HubSpot
    • How to white label the self hosted instance
    • Setting up your availability
      • Adding date override
    • Quick actions using command bar
Powered by GitBook
LogoLogo

Solutions

  • Individual
  • Teams
  • Ultimate
  • Platform

Follow us

  • Twitter
  • LinkedIn

Copyright 2023 Cal.com, Inc. All rights reserved.

On this page
  • The basics
  • Managing users
  • Managing teams
  • The other stuff

Was this helpful?

  1. Enterprise Features
  2. API

API reference

PreviousTypesNextAttendees

Last updated 2 years ago

Was this helpful?

Dive into the specifics of each API endpoint by checking out our complete documentation. Unlike many other platforms, our API gives you access to every single data model within the application, meaning that you can replicate the entire functionality of Cal.com in your own app using the API.

Hence, this page shows you which API routes are most useful in order to prevent you from being overwhelmed with every single route available to you.

The basics

You'll need only a few of the routes to be able to cover the basic functionality.

Managing users

The user endpoints can only be used on self-hosted enterprise instances and not on our hosted platform.

Managing teams

The teams endpoints allow you to programmatically CRUD team data.

The other stuff

Attendees allows you to CRUD the data related to who is attending a particular booking. Useful if you want to create events where many people are invited.

Schedules allows you to set out time blocks when you want to show availability.

Availabilities allows you to map schedules to an event type.

Booking references map meeting details to bookings.

Custom inputs allow you to control which custom inputs are required for your event types.

Destination calendars map bookings for event types to particular calendars.

Event references refer bookings to daily URLs and tokens.

Memberships control mappings of users to particular roles within teams.

Payments track the charges that are required to book certain events.

Selected calendars keeps track of which calendars should be checked for conflicts.

Bookings
Event types
Users
Teams
Attendees
Schedules
Availabilities
Booking References
Custom inputs
Destination calendars
Memberships
Payments
Selected calendars