Contents
Get to know us
The foundation of our onOffice API was already laid in 2006. It was fundamentally revised when the development of the onOffice iOS app started in 2012. In this step, JSON replaced the previous XML requests and responses as well as the range of functions significantly expanded. The next major development step was initiated by the onOffice WordPress plugin. A lot of required API actions could be reused from the functional range of the app.
Nowadays, the API provides read and write access to all major modules (addresses, properties, tasks, calendar). Even with this basic actions a very high degree of functionality is provided by external developers.
Technical Support Team
Do you need help or have a question? Feel free to contact us at apisupport@onoffice.de. Our experts are pleased to help if you have any trouble and the documentation wasn’t useful for you.
You might also want to fill out our support form where we’re going to ask you several specific questions about your problem.
 |
Dennis Rüben |
Speed up your support request
It would be helpful to include following informations (if relevant for the question), so that we can process your questions faster:
- Customer name
- Username
- API version (latest or stable)
- API-Request (in JSON)
- API-Response (in JSON)
- maybe informations about your development enviroment (programming language, tools)
Common solutions
Insufficient user rights
Often, if no data can be read out, the user rights for the API user are not set properly or missing.
The user rights can be set in onOffice enterprise under Extras → Settings → User → Tab API user → Select API user → Tab rights.
Rights set to “only own” are usually not enough for the API user.
Retrieving field names
Many API calls have a data parameter where you can specify the field names to set or to retrieve. Almost all fields specified in the enterprise administration (Extras >> settings >> administration >> tab input fields) are valid and can be passed as elements of an array in the parameter data. The field names for the API are found in the column “field”. A list of field names for the modules address and estate can be downloaded there too.
Via API, the field names can be read out via the API call Field configuration.
A list of action types and action types can be obtained with the API call Kind of action and Type of action.
Create API user
Read more about creating API users.
FAQ / general information
There is also a collection of the most common issues for help and information.