OnOffice

Consume OnOffice API

Actions12

Overview

This node integrates with the OnOffice API to manage real estate-related data, specifically estates, addresses, and relations. For the Address resource with the Get operation, it retrieves a single address record by its ID, allowing users to specify which fields to return.

Common scenarios include:

  • Fetching detailed contact information for a specific address in a real estate database.
  • Integrating address data retrieval into workflows that require up-to-date contact details.
  • Automating data synchronization between OnOffice and other systems by retrieving address records on demand.

Example: A user wants to get the email and name of a contact address by providing its unique ID, enabling further processing or notifications based on this data.

Properties

Name Meaning
ID The unique identifier of the address record to retrieve. This is required.
Fields Comma-separated list of fields to return from the address record (e.g., id,name,email).

Output

The node outputs JSON data structured as follows:

  • success: Boolean indicating if the API call was successful.
  • resourceType: The resource involved, here always "address".
  • operation: The operation performed, here "get".
  • data: An array containing the retrieved address records matching the requested fields.
  • total (optional): Total number of records returned (mainly relevant for "getMany" operations).
  • message (optional): Status message from the API.

If the operation succeeds, the data field contains the requested address information. If an error occurs, the output includes an error message and success set to false.

The node does not output binary data.

Dependencies

  • Requires an API token and secret credential for authenticating with the OnOffice API.
  • Uses HTTP POST requests to the OnOffice API endpoint https://api.onoffice.de/api/v1.
  • Requires n8n credentials configured with valid OnOffice API authentication tokens.

Troubleshooting

  • Invalid JSON in Fields or Filter: If the fields or any filter JSON is malformed, the node throws an error indicating invalid JSON. Ensure all JSON inputs are correctly formatted.
  • Missing or Invalid ID: The ID property is required for the Get operation. Omitting it or providing an incorrect ID will cause the API to fail.
  • API Authentication Errors: If the API token or secret is missing or invalid, the node will return authentication errors. Verify credentials in n8n settings.
  • Network Issues: Network failures result in a network error message. Check connectivity and API availability.
  • API Error Messages: The node surfaces API error messages from OnOffice. Review these messages to understand issues like permission problems or invalid parameters.

Links and References

Discussion