# ZenHost Public API

> Connect your revenue management tool, PMS or script to ZenHost: OAuth 2.0, Properties, Restrictions, bookings, Restriction Batches, guest messaging, signed webhooks and the OpenAPI 3.1 reference.

Every page below is also available as Markdown at the linked URL. The whole documentation in one file: https://zenhost.com/developers/llms-full.txt. The OpenAPI 3.1 spec: https://app.zenhost.com/api/v1/openapi.json.

## Get started
- [Overview](https://zenhost.com/developers.md): Read Properties, Restrictions and bookings, and write Restrictions, for the ZenHost accounts that connect your App.
- [AI agents](https://zenhost.com/developers/ai-agents.md): Give the ZenHost API docs to a coding agent or an AI chat: every page in Markdown, llms.txt, the OpenAPI spec and a prompt to start with.
- [Authentication](https://zenhost.com/developers/authentication.md): Connect a ZenHost account to your App with OAuth 2.0 and PKCE, then run unattended on rotating refresh tokens.
- [Errors](https://zenhost.com/developers/errors.md): The JSON error shape of the ZenHost Public API and every error code, with its HTTP status and what to do.
- [Rate limits](https://zenhost.com/developers/rate-limits.md): Rate limits per App Connection, the 429 answer, and how written changes reach the Sales Channels.
- [Pagination](https://zenhost.com/developers/pagination.md): Read and write every Property of an account, at most 100 per call, by paging through GET /properties.
- [Versioning](https://zenhost.com/developers/versioning.md): How version 1 of the ZenHost Public API evolves without breaking your integration.

## Guides
- [Restriction Batches](https://zenhost.com/developers/guides/restriction-batches.md): Write rates, minimum stays and availability with Restriction Batches: dry run, idempotency and outcome reports.
- [App Events and webhooks](https://zenhost.com/developers/guides/app-events.md): Receive signed App Events on your webhook: event types, URL requirements, signature verification, retries and polling.
- [Guest support](https://zenhost.com/developers/guides/guest-support.md): Answer guests on behalf of the host: the message.received loop, reading and sending messages and photos, SMS billing, closing conversations, Zenny, and access codes.

## API reference
- [Introduction](https://zenhost.com/developers/reference.md): Every endpoint of the ZenHost Public API v1, with parameters, schemas, examples and code samples.
- [List the Properties of the Connection Scope](https://zenhost.com/developers/reference/list-properties.md): GET /api/v1/properties
- [Get one Property of the Connection Scope](https://zenhost.com/developers/reference/get-property.md): GET /api/v1/properties/{id}
- [Get the Property Guide of a Property](https://zenhost.com/developers/reference/get-property-guide.md): GET /api/v1/properties/{id}/guide
- [Read the Restrictions of Properties over a date range](https://zenhost.com/developers/reference/list-restrictions.md): GET /api/v1/restrictions
- [Write Restrictions of Properties over date ranges](https://zenhost.com/developers/reference/submit-restriction-batch.md): POST /api/v1/restriction-batches
- [Read the outcome of a Restriction Batch](https://zenhost.com/developers/reference/get-restriction-batch.md): GET /api/v1/restriction-batches/{id}
- [List the bookings of the Connection Scope](https://zenhost.com/developers/reference/list-bookings.md): GET /api/v1/bookings
- [Get the access codes of a booking](https://zenhost.com/developers/reference/get-booking-lock-codes.md): GET /api/v1/bookings/{booking_id}/lock-codes
- [List the Message Threads of the Connection Scope](https://zenhost.com/developers/reference/list-message-threads.md): GET /api/v1/message-threads
- [Close the conversation of a booking](https://zenhost.com/developers/reference/close-message-thread.md): POST /api/v1/bookings/{booking_id}/message-thread/close
- [Reopen the conversation of a booking](https://zenhost.com/developers/reference/reopen-message-thread.md): POST /api/v1/bookings/{booking_id}/message-thread/reopen
- [List the messages of a booking](https://zenhost.com/developers/reference/list-booking-messages.md): GET /api/v1/bookings/{booking_id}/messages
- [Send a message to the guest of a booking](https://zenhost.com/developers/reference/send-booking-message.md): POST /api/v1/bookings/{booking_id}/messages
- [Download an attachment of a message](https://zenhost.com/developers/reference/get-message-attachment.md): GET /api/v1/bookings/{booking_id}/messages/{message_id}/attachments/{index}
- [This OpenAPI document](https://zenhost.com/developers/reference/get-open-api-document.md): GET /api/v1/openapi.json