This manual is being depreciated. Much of the information here is out of date.

The new Jomres Documentation, updated in 2022, can be found at

Creating a new property with the CMF REST API

Article Index

In this tutorial I will show you how to create a new property using the CMF REST API.

Vision & Purpose

The CMF REST API is your gateway to interacting with Jomres installations via outside systems.

Every user who uses the CMF REST API must be a registered user on the site, and they should already be a property manager of at least one property. Ideally they would not be a Super Property Manager.

The goal here is to demonstrate how you can securely interact with propeties that you have created through the CMF REST API via a client such as Postman, or your own systems. In the documentation this client is referred to as the channel.

We will use Postman to mimic how a remote service could connect to your Jomres site. Going through the tutorial is slow going at the beginning if you're not familiar with Postman, but once you've got the hang of using it, you'll find yourself opting to use the endpoints instead of the Jomres web user interface because it's quicker.