OnOffice

Consume OnOffice API
Join our community

Actions12

Overview

This node integrates with the OnOffice API to manage real estate-related data, specifically estates, addresses, and relations. The Address - Get operation retrieves detailed information about a specific address record by its ID. This is useful when you need to fetch contact or location details associated with real estate properties.

Common scenarios include:

  • Fetching contact details of an address linked to a property.
  • Retrieving address information for further processing or display in workflows.
  • Integrating OnOffice address data into other systems or automations.

Example: You have an address ID from a previous step and want to get the full details (like name, email, first name) of that address to send an email or update another system.

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 output JSON contains the following structure:

  • 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 returned by the API, each containing the requested fields.
  • total (optional): Total number of records if applicable.
  • message (optional): Status message from the API response.
  • rawResponse (optional): The full raw API response object for advanced use.

If the API call fails, the output will contain an error message describing the issue.

The node does not output binary data.

Dependencies

  • Requires an API token and secret credential for authenticating with the OnOffice API.
  • The node sends HTTP POST requests to the OnOffice API endpoint at https://api.onoffice.de/api/latest/api.php.
  • Proper configuration of the API credentials in n8n is necessary before using this node.

Troubleshooting

  • Invalid ID or missing ID: The "ID" property is required. If omitted or incorrect, the API will return an error.
  • Invalid fields format: The "Fields" property must be a comma-separated string of valid field names. Invalid fields may cause incomplete or failed responses.
  • API authentication errors: Ensure the API token and secret are correctly configured and valid.
  • Filter JSON parsing errors: Although not relevant for the "Get" operation, other operations accept JSON filters; invalid JSON will throw errors.
  • Network issues: Network failures or unreachable API endpoints will result in network error messages.
  • API errors: The node surfaces API error messages returned by OnOffice, which can help diagnose issues like permission problems or invalid parameters.

To resolve errors:

  • Verify all required parameters are set correctly.
  • Check API credentials and permissions.
  • Confirm the OnOffice API service status.
  • Review error messages for specific hints.

Links and References

Discussion