API release news 05/24

MAY 2024

New API call “Get email info”:

A new API call “Get email info” has been created, which reads out all property and address links in an email.

This call replaces “Get email links“, which can only read 1 address link per email.

Email info

New parameter “addressIds” in API call “Do Email links”:

The new parameter addressIds in the API call “Do Email links” can be used to transfer an array of addresses that are to be linked to the email. The parameter can be used instead of addressid, which can only be used to link 1 address.

Do Email links

New parameter “useDefaultMailAccount” in API call “Send Appointment confirmation”:

The new parameter useDefaultMailAccount can be used to set whether the sender mail address from the user settings should be used for sending.

Send Appointment confirmation

API release news 03/24

MARCH 2024

Do File Upload: new parameter applyWaterMark

Uploading images to a property via the onOffice API now also supports watermarks. Previously, images that were uploaded to the software from outside were not automatically watermarked.
This behavior has been adjusted. For this purpose, the “File upload” call contains the new parameter applyWaterMark, which can be used to control whether the configured watermark from enterprise is set.

File upload

API release news 12/23


Read search criteria: new response parameter “characteristic”

Search criteria

The onOffice API can now read out the characteristics of search criteria, e.g. whether they were created manually or automatically. For this purpose, the response of the API call “get search criteria” has been supplemented by the item “characteristic”.

Read addresses: onOffice API error message if filter is missing


Previously, all addresses were exported unfiltered by the onOffice API because the API user did not have access to the “filterid” parameter. From now on, the system therefore displays the API error message “the requested filterid %s is unknown” and does not execute the call.

API news / RSS feed

The latest API changes are listed here once a month.
The API news and latest changes can be subscribed as a RSS feed with the URL https://apidoc.onoffice.de/feed.

The last 15 changed pages are