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

# Guests

### Overview

The Guests API section focuses on handling data for individuals who have made or are associated with reservations within your system. It's a vital component for personalizing guest experiences, managing guest-related operations efficiently, and ensuring that guest data is accurate and up to date

### Key capabilities

* [**Guest Schema**](/chekin-public-api/api-reference/guests/guest-schema.md)\
  Describes the structure and types of guest data that can be stored or retrieved, such as names, contact information, preferences, and associated reservations. This schema serves as a blueprint for understanding how guest information is formatted and utilized within the API
* [**Guest Schema v2**](/chekin-public-api/api-reference/guests/guest-schema-v2.md)\
  Returns the complete guest form in one response, including the fields and agreement clauses configured through Custom forms in the dashboard. Use it when your properties rely on custom forms
* [**Location fields**](/chekin-public-api/api-reference/guests/location-and-document-fields.md)\
  Explains what to send for fields that point to an official division (Italian place of birth, Spanish residence province…)
* [**Create Guest**](/chekin-public-api/api-reference/guests/create-guest.md)\
  Enables the addition of a new guest record to the system. This function is often used when a new reservation is made, allowing for the capture of guest details at the time of booking
* [**Retrieve One Guest**](/chekin-public-api/api-reference/guests/retrieve-guests-information.md)\
  Allows for fetching detailed information about a specific guest by their unique identifier. This is crucial for accessing individual guest profiles, including their reservation history and preferences
* [**Update Guest**](/chekin-public-api/api-reference/guests/update-guest.md)\
  Provides the ability to modify existing guest information. This may be necessary to update contact details, preferences, or other pertinent information as it changes over time
* [**Delete Guest**](/chekin-public-api/api-reference/guests/delete-guest.md)\
  Facilitates the removal of a guest record from the system. This action might be used in cases where data needs to be purged for privacy reasons or when a guest requests their information be deleted

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