Introduction

Welcome to the Foyer Public API documentation.

The Public API, tagged v1, lets you read your hotel's reservations, rates and availability programmatically over conventional HTTP requests.

The API in a nutshell:

• RESTful, resource-oriented URLs
• JSON all the way — Content-Type: application/json, Accept: application/json
• Authorisation via API keys you generate in the app
• Simple versioning via a path prefix, /api/v1/...
• Read-only today: every documented endpoint is a GET

Requests

Entities are represented as resources, each with its own URL. All endpoints are reached with the GET method and are therefore idempotent.

Authentication

Every request carries an API key as a bearer token.

More on generating and scoping API keys.

Versioning

The version is part of the path, for example /api/v1/developer/stays. A future version would be served alongside under its own prefix.