Skip to main content

​
Overview

The Reservations API allows you to create, retrieve, and manage appointment reservations in the Zenda system. All endpoints require Bearer token authentication.

​
Base Endpoint

/api/reservations

​
Available Endpoints

​
Creating Reservations

Create Without Payment

Create a reservation without requiring payment

Create With Payment

Create a reservation with payment

​
Retrieving Reservations

Get All Reservations

Retrieve all reservations in the system

Get By User

Get reservations for a specific user

Get By Professional

Get reservations for a specific professional

Get One

Retrieve a single reservation by ID

​
Availability & Management

Get Availability

Check professional availability

Delete Reservation

Delete a reservation

​
Reservation Object

All reservation objects follow this structure: 
interface Reservation {
  id: string;
  client_id: string;
  professional_id: string;
  start_time: string;
  end_time: string;
  status: "PENDING" | "CONFIRMED" | "CANCELLED";
  session_modality: "Virtual" | "Presencial" | "";
  created_at: string;
}

​
Session Modalities

Reservations support different session modalities:
  • Virtual - Online/remote sessions
  • Presencial - In-person sessions at the professional’s office
  • Empty string - Not specified

​
Reservation Status

Reservations can have the following statuses:
  • PENDING - Reservation created but not confirmed
  • CONFIRMED - Reservation confirmed
  • CANCELLED - Reservation cancelled

​
Authentication

All reservation endpoints require authentication. See the Authentication guide for details.

​
Next Steps

Explore the individual endpoint documentation to learn how to:
  • Create reservations with or without payment
  • Query reservations by user or professional
  • Check availability for scheduling
  • Manage existing reservations

Build docs developers (and LLMs) love

Get started for freeTalk to us