Skip to main content

Appointments

The Appointments API provides comprehensive endpoints for managing calendar appointments in the Onlive system. These endpoints allow you to create, retrieve, update, and delete appointments, as well as manage related features like reminders, guests, and voting.

🔐 Authentication​

All Appointments API endpoints require authentication using the ONLIVESITE authentication scheme. Include the following header in all requests:

Authorization: ONLIVESITE Credential:ONLIVEAccessKeyId, Signature=CalculatedSignature

📌 Available Endpoints​

Appointment Management​

  • Create Appointment - Schedule a new appointment
  • Get Appointment - Retrieve specific appointment details
  • List Appointments - Get a paginated list of appointments with filtering options
  • Update Appointment - Modify an existing appointment's information
  • Delete Appointment - Cancel and remove an appointment

Additional Features​

  • Appointment Votes - Get voting and review information for an appointment

💡 Common Use Cases​

  • Scheduling one-time or recurring appointments
  • Managing appointment reminders and notifications
  • Adding and managing appointment guests
  • Handling appointment reviews and feedback
  • Appointment search and filtering
  • Calendar integration and synchronization

For detailed information about specific operations, please refer to the individual endpoint documentation sections.