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 of the address they want returned.

Common scenarios include:

  • Fetching detailed contact information for a specific address in a real estate database.
  • Retrieving selective address fields (e.g., name, email) to use in workflows such as notifications or CRM updates.
  • Integrating OnOffice address data into other systems or automations.

Example: You have an address ID from a previous step and want to get the contact's name and email to send a personalized email.

Properties

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

Output

The node outputs JSON data structured as follows:

  • success: Boolean indicating if the API call was successful.
  • resourceType: The resource type, here always "address".
  • operation: The operation performed, here "get".
  • data: An array of address records matching the request. For the "get" operation, this will contain one record with the requested fields.
  • total: (optional) Total number of records returned, present if metadata is available.
  • message: (optional) Status message from the API.

If the API call fails, the output includes:

  • success: false
  • error: Error message describing the failure.

The node does not output binary data.

Dependencies

  • Requires an API token and secret for authenticating with the OnOffice API.
  • Needs the OnOffice API credentials configured in n8n.
  • Uses HTTP POST requests to the OnOffice API endpoint https://api.onoffice.de/api/v1.
  • Generates HMAC signatures for request authentication.

Troubleshooting

  • Invalid JSON in Fields or Filter: If the "Fields" or any filter JSON is malformed, the node throws an error. Ensure all JSON inputs are valid.
  • Missing or Invalid ID: The "ID" property is required for the Get operation. Omitting it or providing an invalid ID will cause errors.
  • API Authentication Errors: Incorrect or missing API credentials will result in authentication failures.
  • Network Issues: Network errors during the HTTP request will be reported with relevant messages.
  • API Errors: If the OnOffice API returns an error status, the node surfaces the API's error message.

To resolve issues:

  • Verify that the ID is correct and exists in OnOffice.
  • Check that the API credentials are properly set up and valid.
  • Validate JSON inputs carefully.
  • Review error messages for hints on what went wrong.

Links and References

Discussion