casavi stands for an open integration culture. Thanks to our powerful API casavi is your central platform for the complete digitalisation of your property management processes. No duplicate data administration thanks to a direct connection to accounting and ERP systems – and through our big partner network there is no limit to your possibilities when it comes to additional functionality.

Using this API you can connect to most of the functionality that casavi has to offer. All data is scoped to one customer account. Examples you can do with this API are:

• import & update master data
• import documents and track if they have been downloaded by customers
• connect another workflow management system to the ticket system casavi uses.

This documentation is generated from a Open API 2.0 document. Before we get to all the endpoints we explain the authentication. In the following section we continue with the most often found use cases.

We are actively developing our API and extend it to cover new use cases. To stay up to date you can have a look at the Changelog and be sure to subscribe to our API newsletter. There you will get updates about new features and bugfixes, deprecations etc.

You need an API key & a secret (supplied by your casavi customer service). Then follow these steps to authenticate against this API:

1. POST to /authenticate with application/json payload { key, secret }.
2. You receive back a json with payload { token, expiresAt }.
3. Use the token in the header field token of other requests.

When an endpoint in this API is receiving or returning an id this is not the casavi internal database id, but instead a customer supplied reference id. This id is also shown in the management view as "Referenz ID". It can be anything you want want, so a database id or - as we recommend - an identifier that is human relatable like the property number.

Dates/Times are always returned in ISO 8601 format (YYYY-MM-DDThh:mm:ss.sssZ). They are also returned in UTC.

• Import master data (properties, contacts and units) into casavi
• Synchronize/update tickets

We also have a documentation for the Community API which describes the API the community app uses.

casavi authentication

A main process needed to work with casavi is to get master data from the ERP or property management software into casavi regularly. For this we use an asynchronous process. Roughly the process is as follows:

Send your data according to the import model to the import endpoint. All the data in that request is automatically imported in the correct order, so that contacts and properties are created first, followed by units and finally documents. When supplying individual imports to the API this order has to be taken into account as well as no units for example can be imported if there is not yet the contact in casavi with a matching reference id.

The import works asynchronously and with a queue, meaning that not all imports are guaranteed to be imported at once. This endpoint will return a job ID that you can use to check the status of the job via jobs/{jobId}.