Appointments Guide

This guide covers how to work with appointments using the Public API.

Overview

The Appointments API allows you to:

• Retrieve appointment details
• Preview multiple appointments
• Create new appointments
• Update existing appointments
• Delete appointments

Base Endpoint

All appointment endpoints are under:

/{tenantId}/appointment

Operations

Get Single Appointment

Retrieve details for a specific appointment:

GET /{tenantId}/appointment?appointmentId={id}
Authorization: Bearer {token}
tenantId: {tenant-id}

Get Appointments Preview

Retrieve a preview of multiple appointments:

GET /{tenantId}/appointment/preview
Authorization: Bearer {token}
tenantId: {tenant-id}

Create Appointment

Create a new appointment:

POST /{tenantId}/appointment
Authorization: Bearer {token}
tenantId: {tenant-id}
Content-Type: application/json

{
  "title": "Meeting with Client",
  "startTime": "2024-01-15T10:00:00Z",
  "endTime": "2024-01-15T11:00:00Z",
  "description": "Quarterly review meeting"
}

Update Appointment

Update an existing appointment:

PUT /{tenantId}/appointment
Authorization: Bearer {token}
tenantId: {tenant-id}
Content-Type: application/json

{
  "appointmentId": "123",
  "title": "Updated Meeting Title",
  "startTime": "2024-01-15T10:30:00Z",
  "endTime": "2024-01-15T11:30:00Z"
}

Delete Appointment

Delete an appointment:

DELETE /{tenantId}/appointment
Authorization: Bearer {token}
tenantId: {tenant-id}
Content-Type: application/json

{
  "appointmentId": "123"
}

Important Notes

• All appointment operations require authentication
• The tenantId must be provided both in the URL path and as a header
• Dates and times should be in ISO 8601 format
• All operations use JSON for request and response bodies