> For the complete documentation index, see [llms.txt](https://chekin.gitbook.io/chekin-public-api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://chekin.gitbook.io/chekin-public-api/api-reference/reservations.md).

# Reservations

### Overview

The Reservations API section of our platform is dedicated to managing reservations

This suite of API endpoints allows you to interact with reservation data in various ways, including listing all reservations, retrieving details for a specific reservation, creating new reservations, updating existing ones, and deleting reservations

Whether you're integrating our reservation system into your software or managing reservations directly, these APIs provide the necessary tools to handle reservation data efficiently and securely

### Key Capabilities

* [**List Reservations**](/chekin-public-api/api-reference/reservations/list-reservations.md)\
  Retrieve a list of all reservations, with the option to filter and sort the data based on specific criteria. This is useful for getting an overview of all bookings
* [**Retrieve a Reservation**](/chekin-public-api/api-reference/reservations/retrieve-reservations.md)\
  Access detailed information about a single reservation. This is useful for viewing or displaying the specifics of a booking
* [**Create a Reservation**](/chekin-public-api/api-reference/reservations/create-reservations.md)\
  Add a new reservation to the system. This allows for the creation of new bookings with specified details
* [**Update a Reservation**](/chekin-public-api/api-reference/reservations/update-reservations.md)\
  Modify the details of an existing reservation. This can be used to change booking times, customer details, or any other reservation information
* [**Delete a Reservation**](/chekin-public-api/api-reference/reservations/delete-reservations.md)\
  Remove a reservation from the system. This is necessary when a booking is canceled or no longer needed

### How to use

* Authentication is required for all endpoints within the Reservation API, ensuring that only authorized users can manage housing data. This is done via a token received on [Authentication](/chekin-public-api/authentication.md) method
* Requests to these endpoints must be made using the correct HTTP method (GET for listing and retrieving, POST for creating, PUT/PATCH for updating, and DELETE for deleting) to ensure they are processed correctly
* Parameters and request bodies should be structured as per the individual endpoint requirements, detailed in the subpage documentation for each action