Download OpenAPI specification:Download
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:
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:
/authenticate
with application/json payload { key, secret }
.{ token, expiresAt }
.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.
We also have a documentation for the Community API which describes the API the community app uses.
key and secret can be obtained from your connectivity contact at casavi and give access to a whole casavi account.
Deprecation:
Before this method used three parameters: apiKey
, email
and password
.
This is deprecated, but still supported because we are mapping the parameters:
secret
equals password
key
equals apiKey
andemail
is just ignored.Data to authenticate into casavi
key required | string API key. Should not be empty |
secret required | string API secret |
{- "key": "04523b90-9ee1-49f7-af31-b1f24efe84ad",
- "secret": "ksdasji0-sf818-nfn81-ms9a-ams9d9a9as"
}
{- "token": "a2cf47a9-3d2e-455e-a34b-7a79f11aa7f9",
- "expiresAt": "1985-12-05T15:31:10.000Z"
}
Refresh access token
Data to authenticate into casavi
apiKey required | string API key. Should not be empty |
token required | string Old access token |
{- "apiKey": "04523b90-9ee1-49f7-af31-b1f24efe84ad",
- "token": "a2cf47a9-3d2e-455e-a34b-7a79f11aa7f9"
}
{- "token": "a2cf47a9-3d2e-455e-a34b-7a79f11aa7f9",
- "expiresAt": "1985-12-05T15:31:10.000Z"
}
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}
.
The import endpoint takes in a master data object and asynchronously imports it into casavi.
Data to be imported into casavi
Array of objects (Contact) | |
Array of objects (PropertyImport) | |
Array of objects (Responsibility) |
{- "contacts": [
- {
- "id": "C-0000312",
- "title": "Doctor",
- "salutation": "Family",
- "firstName": "Joe",
- "lastName": "Smith",
- "companyName": "ACME Industries",
- "companyRole": "Director",
- "email": "joe.smith@acme.com",
- "telephone": "+49 (0) 89 132",
- "mobile": "+49 (0) 89 132",
- "fax": "+49 (0) 89 132",
- "street": "Example street 7",
- "postalCode": "80331",
- "city": "Munich",
- "country": "Germany",
- "note": "Prefers to be contacted by email, telephone only in working hours.",
- "preferredWayOfContact": "LETTER",
- "customFields": {
- "Email2": "someemail@domain.tld",
- "Anschrift": "Max Mustermann und Maria Musterfrau"
}
}
], - "properties": [
- {
- "id": "P-00451",
- "name": "Easy Living Apartments",
- "note": "Test description",
- "country": "Germany",
- "city": "Munich",
- "postalCode": 80331,
- "addresses": [
- {
- "street": "Mai