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

# Housings

### Overview

The Housing API encompasses a set of endpoints focused on managing the properties or housing units associated with reservations. This section of the API facilitates various operations that allow for comprehensive management of housing data, suitable for applications ranging from property management systems to booking platforms

### Key Capabilities

* [**List Housings**](/chekin-public-api/api-reference/housings/list-housings.md)\
  Retrieve a comprehensive list of all housing units available within the system, with options to filter and sort based on specific criteria
* [**Retrieve a Housing**](/chekin-public-api/api-reference/housings/retrieve-housing.md)\
  Access detailed information about a specific housing unit, including attributes like location, size, and availability
* [**Create Housing**](/chekin-public-api/api-reference/housings/create-housing.md)\
  Add a new housing unit to the system, specifying details such as address, capacity, amenities, and other relevant information
* [**Update Housing**](/chekin-public-api/api-reference/housings/config-housing-settings.md)\
  Modify the details of an existing housing unit, allowing for the correction of information or updates to unit features
* [**Delete Housing**](/chekin-public-api/api-reference/housings/delete-housing.md)\
  Remove a housing unit from the system, useful for properties that are no longer available or have been decommissioned

### 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