> 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/rooms.md).

# Rooms

### Overview

The Rooms API section is dedicated to the comprehensive management of rooms across various properties or housing units within the system. It enables a detailed approach to handling each room's characteristics, thus providing flexibility and precision in property management and booking systems

### Key capabilities

* [**List Rooms**](/chekin-public-api/api-reference/rooms/list-rooms.md)\
  Retrieves a list of all rooms within a specified housing unit or across the system, complete with the ability to filter and sort the results based on criteria like room type, availability, or features.
* [**Retrieve One Room**](/chekin-public-api/api-reference/rooms/retrieve-room.md)\
  Offers detailed information about a specific room, identified by its unique ID, including its features, type, and current status.
* [**Create Room**](/chekin-public-api/api-reference/rooms/create-room.md)\
  Allows for the addition of a new room to a housing unit, requiring detailed information such as room type, capacity, and amenities.
* [**Create Multiple Rooms**](/chekin-public-api/api-reference/rooms/create-multiple-rooms.md)\
  Enables the creation of multiple rooms in a single request, streamlining the process of populating a new or existing housing unit with room information.
* [**Update Room**](/chekin-public-api/api-reference/rooms/update-room.md)\
  Provides the capability to modify details of an existing room, useful for updating room features, status, or information following renovations or changes in amenities.
* [**Delete Room**](/chekin-public-api/api-reference/rooms/delete-room.md)\
  Facilitates the removal of a room from the system, an action used when a room is no longer available, has been repurposed, or the housing unit itself is being removed or repurposed.

### How to use

* Authentication is required for all endpoints within the Housing API, ensuring that only authorized users can manage housing data. This is done via a token received on [Authentication](/chekin-public-api/authentication.md)
* Requests to these endpoints must be made using the appropriate HTTP method (GET for retrieval, POST for creation, PATCH for updates, and DELETE for deletion) 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