API Documentation

The Roomkey API allows registered applications to retrieve data and in turn post data to the RoomKey Backend.

Use of this API implies that you have reviewed and agreed to our API Terms & conditions.

The RoomKey API is organized around REST. It is designed to have predictable, resource-oriented urls and to use HTTP verbs (GET, POST, PUT, DELETE, etc.) and http response codes to communicate with clients.

Requests will receive HTTP Responses containing json or xml payloads. The client can specify the preferred format in the header of the HTTP request.

Considerations

  • Currently, there are no endpoints capable of returning only the records that have changed or that have been created since your last call.
  • Timezones are handled according to the property and therefore dates and times are local for each property.

Versions

Current Version is 2.6.0.2

Release notes for the current version and previous versions can be found in RoomKeyPMS release notes.