canonical: https://jentic.com/apis/roomkeypms.com/roomkeypms

# RoomKey PMS API

RoomKey Property Management System REST API for hotel operations including reservations, guests, rates, statistics, and transactions. The API exposes 35 endpoints.

## For AI agents

Programmatically health check, list all hotels. Covers 35 operations.

## Scope

Does not handle payments, communications, or crm - use for e-commerce only.

## Capabilities

- Health check
- List all hotels
- Get hotel details
- Query and filter RoomKey PMS API records by parameters
- Monitor RoomKey PMS API operational status and events

## Use cases

### E-Commerce Operations

Use the RoomKey PMS API to perform e commerce operations programmatically. The API provides 35 endpoints covering core functionality including health check, list all hotels, get hotel details.

Example prompt: Call GET /ping to health check

### Automated CityLedger Management

Automate cityledger operations by combining multiple RoomKey PMS API endpoints. Agents can list all hotels and then get hotel details in a single workflow.

Example prompt: Call GET /hotels to list all hotels, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call RoomKey PMS API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle none tokens manually.

Example prompt: Search Jentic for 'health check', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/ping` | Health check |
| GET | `/hotels` | List all hotels |
| GET | `/hotels/{hotelId}` | Get hotel details |
| GET | `/hotels/{hotelId}/server` | Get hotel server name |
| GET | `/hotels/{hotelId}/availabilities` | Get room availability |
| GET | `/hotels/{hotelId}/guests` | List guests |
| GET | `/hotels/{hotelId}/guests/{guestId}` | Get guest by ID |
| GET | `/hotels/{hotelId}/guests/roominquiry` | Get guest by room number |

## Key resources

- **CityLedger** — Operations related to CityLedger
- **ERES** — Operations related to ERES
- **Groups** — Operations related to Groups
- **Guests** — Operations related to Guests
- **Hotels** — Operations related to Hotels

## Why Jentic

- **Setup:** Wiring the RoomKey PMS API by hand still means writing the client against its welcometorsi.net host and paging hotel and guest data even though it needs no auth. Through Jentic you install once, import the RoomKey PMS API from the API Directory, and your agent calls it.
- **Permission scoping:** RoomKey PMS puts the hotel id in the URL path (`/hotels/{hotelId}/...`), so a rule can pin your agent to one hotel: it can read that hotel's availabilities and guests and nothing else. You choose the operations it may call, and it can run only the ones you allow.
- **Credential handling:** The RoomKey PMS API needs no credential, so there is no secret to store; any configuration your Jentic One instance holds stays out of the agent's prompt, logs, and context.
- **Discovery method:** Agents search Jentic by intent such as 'check availability for a hotel' or 'look up a guest', and Jentic returns the matching RoomKey PMS operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Shopify** — Alternative e commerce API
- **Stripe** — Alternative e commerce API

## FAQ

### What authentication does the RoomKey PMS API use?

The RoomKey PMS API uses no authentication. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I health check with the RoomKey PMS API?

Yes. Use the GET /ping endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the RoomKey PMS API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I health check through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'health check'. Jentic returns the matching RoomKey PMS API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the RoomKey PMS API have?

The RoomKey PMS API exposes 35 endpoints covering cityledger, eres, groups operations.

### Can I limit what my agent is allowed to do with the RoomKey PMS API?

Yes. Because you run Jentic One yourself, your own rules decide which RoomKey PMS operations and configuration the agent may use. Since the RoomKey PMS API carries the hotel id in the URL path (`/hotels/{hotelId}/...`), you can pin an agent to a single hotel and allow only read calls such as GET `/hotels/{hotelId}/availabilities` and GET `/hotels/{hotelId}/guests` while blocking everything else. The agent can call only the operations you have explicitly permitted.