# API Reference

This reference covers getting started, authentication, rate limits, and the version 1 endpoints for health, rooms, reservations, and rates. Every endpoint includes request details, required headers, the scope it needs, and code examples.

Canonical URL: https://innexo.com/developers/docs

## Getting Started

All requests are made against https://api.innexo.com. The introduction section of the reference covers getting started, authentication, and rate limits. A built-in Try it out panel lets you enter a key and send a request to the selected endpoint directly from the documentation; use your sandbox key to test without affecting live data.

## Authentication

Every request carries two headers: Authorization, a string set to Bearer followed by your key, and Content-Type, a string set to application/json. Sandbox keys begin with innx_sk_test_. A key is required for every endpoint except the public health check.

## Endpoints

All four version 1 endpoints live under the /api/v1 prefix and accept GET requests:

GET /health — Check service health and connectivity. Scope required: public. Responds with a status of ok and the version number, currently 1.0.0.

GET /rooms — List all rooms in the hotel. Scope required: rooms:read. Each room includes an id, number, type (for example KING or DOUBLE), status (for example clean or dirty), and an occupied flag.

GET /reservations — List current and upcoming reservations. Scope required: reservations:read. Each reservation includes an id, guest name, check-in date, check-out date, and status such as confirmed.

GET /rates — Retrieve current room rates. Scope required: rates:read. Each entry includes a room type, a rate, and a currency such as USD.

## Code Examples

Each endpoint page includes examples in JavaScript, Python, and cURL. The JavaScript example calls fetch with an Authorization header of Bearer YOUR_API_KEY and parses the JSON response. The Python example uses the requests library with the same header and prints the JSON. The cURL example sends the request with the -X method flag and an -H Authorization header.

## Try It Out

Enter your key, choose an endpoint, and click Send Request. The panel shows a success indicator, the response time in milliseconds, and the response body, which you can copy to your clipboard. If you try a non-public endpoint without a key, the panel will prompt you to enter one.

## Related pages

- New to the platform? The [developer overview](https://innexo.com/developers) summarizes real-time data, secure auth, sandbox mode, webhooks, and multi-hotel access.
- Traffic to the interface is encrypted with TLS 1.2 or higher; see the [security page](https://innexo.com/security) for the full set of controls.
- Automated access must stay within approved API usage as described in the [Terms of Service](https://innexo.com/terms-of-service).
- The interface is one part of a broader [integration ecosystem](https://innexo.com/how-it-works) that includes payment gateways, channel managers, and accounting software.
