Skip to main content
This API relies on specific data elements and formats for some key features, so it’s important to understand and use them correctly.

​
IDs

Most endpoints use an object’s ID, such as Guest, Reservation, or Room ID. These are all UUIDs, and they follow standard REST API usage.

​
Property ID

The Property ID is a UUID that uniquely identifies the hotel property, and it’s required as a header in all requests.

​
PMS ID

The PMS ID is the ID in the PMS of the specific element being referenced, usually a Guest or Reservation. These can be in any format and MUST be unique in a property, but can be reused or repeated across properties, since they are usually generated by individual property PMS systems.

​
Global IDs

We are exploring support for Global Guest and Reservation IDs, which some hotels are starting to use, and which would be globally unique. These are especially valuable in tracking guests across PMS and properties. Since KYC is a global system, this also helps us track these key elements. These are NOT yet supported.

​
Timestamps

All endpoints will return timestamps, such as the response timestamp, plus may objects also return createdAt and updatedAt timestamps. All timestamps are ISO8601 UTC timestamps with Z timezone markers in this format: YYYY-MM-DDTHH:mm:ssZ The API NEVER accepts nor returns non-UTC or hotel property local times. You must make these timezone conversions on your side. The property timezone is available from the /properties endpoint. This endpoint may eventually also return the current GMT offset and current local time and date.