# Lodgehog PMS API

> Read-only REST API for a hotel property management system. Lets an
> integration pull reservations (with their room lines, guests, folio charges
> and payments), guests and rooms for one property, and receive signed webhooks
> when a reservation is created, changed or cancelled.

Authentication is a per-property API key sent as `Authorization: Bearer lh_live_...`.
Keys are created by a property administrator under Property settings > API & Webhooks.
The API never writes: there is no way to create or change a reservation through it.

## Docs

- [OpenAPI schema (YAML)](https://api.lodgehog.com/v1/schema/): the machine-readable contract. Start here.
- [OpenAPI schema (JSON)](https://api.lodgehog.com/v1/schema/?format=json): the same document as JSON.
- [Interactive reference](https://api.lodgehog.com/v1/docs/): Swagger UI over the schema.
- [Full reference](https://api.lodgehog.com/llms-full.txt): every endpoint, filter, error and the webhook contract, in one file.

## Endpoints

- [Reservations](https://api.lodgehog.com/v1/reservations/): a property's reservations, newest first, each one whole.
- [Reservation detail](https://api.lodgehog.com/v1/reservations/{id}/): one reservation, including cancelled ones.
- [Guests](https://api.lodgehog.com/v1/guests/): the property's guest records.
- [Rooms](https://api.lodgehog.com/v1/rooms/): rooms, to resolve the ids on a reservation.
- [Room categories](https://api.lodgehog.com/v1/room-categories/): room categories.

## Optional

- [Webhooks](https://api.lodgehog.com/llms-full.txt): delivery envelope, retry behaviour and HMAC signature verification, in the full reference.