Calendars Overview - HoopAI Help Center

The Calendars API provides complete control over calendar configuration and appointment scheduling in the HoopAI Platform. Use it to create and configure calendars, query available free slots, book and manage appointments, create block slots, define calendar groups, manage per-calendar notification settings, configure scheduling resources such as rooms and equipment, and build reusable availability schedules that can be applied across multiple calendars.

Base URL

https://services.leadconnectorhq.com

Authentication

All endpoints require a Bearer token and an API version header.

Authorization: Bearer <access_token>
Version: 2021-07-28

See OAuth 2.0 to obtain an access token.

OAuth scopes

Scope	Access
`calendars.readonly`	Read calendars, groups, resources, schedules, and notifications
`calendars.write`	Create, update, and delete calendars, groups, resources, schedules, and notifications
`calendars/events.readonly`	Read calendar events, appointments, and blocked slots
`calendars/events.write`	Create, update, and delete appointments and blocked slots

Quick start

Query available free slots for a calendar:

curl -X GET "https://services.leadconnectorhq.com/calendars/{calendarId}/free-slots?locationId=sadadya1u12basyhasd&startDate=1716230400000&endDate=1716316800000&timezone=America/New_York" \
  -H "Authorization: Bearer <access_token>" \
  -H "Version: 2021-07-28"

Endpoints

Method	Path	Description
`GET`	`/calendars/`	Get calendars
`POST`	`/calendars/`	Create calendar
`GET`	`/calendars/{calendarId}`	Get calendar
`PUT`	`/calendars/{calendarId}`	Update calendar
`DELETE`	`/calendars/{calendarId}`	Delete calendar
`GET`	`/calendars/{calendarId}/free-slots`	Get free slots
`GET`	`/calendars/groups`	Get groups
`POST`	`/calendars/groups`	Create calendar group
`POST`	`/calendars/groups/validate-slug`	Validate group slug
`GET`	`/calendars/groups/{groupId}`	Get group
`PUT`	`/calendars/groups/{groupId}`	Update group
`DELETE`	`/calendars/groups/{groupId}`	Delete group
`PUT`	`/calendars/groups/{groupId}/status`	Disable group
`GET`	`/calendars/events`	Get calendar events
`GET`	`/calendars/blocked-slots`	Get blocked slots
`POST`	`/calendars/events/appointments`	Create appointment
`GET`	`/calendars/events/appointments/{eventId}`	Get appointment
`PUT`	`/calendars/events/appointments/{eventId}`	Update appointment
`POST`	`/calendars/events/block-slots`	Create block slot
`PUT`	`/calendars/events/block-slots/{eventId}`	Update block slot
`DELETE`	`/calendars/events/{eventId}`	Delete event
`GET`	`/calendars/appointments/{appointmentId}/notes`	Get notes
`POST`	`/calendars/appointments/{appointmentId}/notes`	Create note
`PUT`	`/calendars/appointments/{appointmentId}/notes/{noteId}`	Update note
`DELETE`	`/calendars/appointments/{appointmentId}/notes/{noteId}`	Delete note
`GET`	`/calendars/resources/{resourceType}`	List calendar resources
`POST`	`/calendars/resources/{resourceType}`	Create calendar resource
`GET`	`/calendars/resources/{resourceType}/{id}`	Get calendar resource
`PUT`	`/calendars/resources/{resourceType}/{id}`	Update calendar resource
`DELETE`	`/calendars/resources/{resourceType}/{id}`	Delete calendar resource
`GET`	`/calendars/{calendarId}/notifications`	Get notifications
`POST`	`/calendars/{calendarId}/notifications`	Create notification
`GET`	`/calendars/{calendarId}/notifications/{notificationId}`	Get notification
`PUT`	`/calendars/{calendarId}/notifications/{notificationId}`	Update notification
`DELETE`	`/calendars/{calendarId}/notifications/{notificationId}`	Delete notification
`GET`	`/calendars/schedules/search`	List user availability schedules
`POST`	`/calendars/schedules`	Create user availability schedule
`GET`	`/calendars/schedules/{id}`	Get user availability schedule
`PUT`	`/calendars/schedules/{id}`	Update user availability schedule
`DELETE`	`/calendars/schedules/{id}`	Delete user availability schedule
`PUT`	`/calendars/schedules/{id}/associations/{calendarId}`	Apply availability schedule to a calendar
`DELETE`	`/calendars/schedules/{id}/associations/{calendarId}`	Remove availability schedule from a calendar

Contacts API — Retrieve contact appointments and link bookings to contact records
Conversations API — Send appointment confirmation and reminder messages
Users API — Assign calendars and schedules to platform users

​Base URL

​Authentication

​OAuth scopes

​Quick start

​Endpoints

​Related

Base URL

Authentication

OAuth scopes

Quick start

Endpoints

Related