API Reference Overview

This document introduces APIs that provide three main functionalities: scheduling appointments, managing calendars, and team management. Each section will explain what each API represents and how to utilize them.

EventType

Retrieves detailed information about the event type that can be booked. Acts as a prerequisite for using the Booking API.
Parameter Reference: Understands the parameters needed for the Booking API.

• List Event Types
• Get Event Type

GET /v1/event_types/mzgdPJVBb7RE
{
  "data": {
    ...
    "eventTypeId": "mzgdPJVBb7RE",
    "locations": [
      { "locationId": "googleMeet" }
    ],
    ...
  }
}

This API allows checking the availability on the booking. It provides available schedule information for a specific event type, helping users to determine if they can book an event for their desired date and time.

• Get Event Type Available Schedules

GET /v1/event_types/mzgdPJVBb7RE/available_schedules
{
  "data": [
    {
      "startedAt": "2024-04-01T02:00:00.000Z",
      "remainingCapacity": 1
    }
  ]
}

Booking

The core API for scheduling bookings. Through this API, operations such as creating, viewing, updating, rescheduling, and canceling events are supported.

• Create Booking
  This API supports the necessary operations for users to complete the booking process. By referencing the EventType API to obtain the necessary parameters and using the POST Booking API, users can make events.

  POST /v1/bookings
  {
  "eventTypeId": "mzgdPJVBb7RE",
  "timeZone": "Asia/Tokyo",
  "startedAt": "2024-04-01T02:00:00.000Z",
  "email": "guest@example.com",
  "name": "average joe",
  "location": "googleMeet"
  }
  

other booking APIs.

• List Bookings
• Update Booking
• Reschedule Booking
• Cancel Booking
• Get Booking Contacts

Schedule

An API for managing schedules displayed on a team calendar and blocking availabilty of event types. Using this API, users can create, view, update, and delete their schedules.

• List Schedule
• Create Schedule
• Update Schedule
• Delete Schedule

Availability

An API for referencing a team member's available schedule.

• List User Availability Calendars
• Get User Availability Calendar

Organization

An API for referencing organization information. Through this API, basic information about organizations.

• Get Organization Team

Organization User

An API for managing information of users belonging to an organization. It supports viewing, updating, and deleting users within an organization.

• List Organization Users
• Get Organization User
• Delete Organization User
• Update Organization User

Organization Invitation

An API for managing invitations to an organization. Used when inviting new members to an organization, this API supports creating, viewing, and deleting invitations.

• List Organization Invitations
• Get Organization Invitation
• Create Organiztion Invitation
• Delete Organiztion Invitation