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, then use this data to send personalized emails or update CRM records.

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: Contains the retrieved address records under records if available.
  • total: (optional) Total number of records returned (usually 1 for "get").
  • message: Informational message from the API status (present for create/update/delete operations).

The output JSON array contains one item per input item processed, each enriched with execution metadata.

No binary data output is produced by this node.

Dependencies

  • Requires an API token and secret credential for authenticating with the OnOffice API.
  • Needs network access to https://api.onoffice.de/api/latest/api.php.
  • Uses HMAC signature generation for request authentication.
  • Requires n8n credentials setup for the OnOffice API with appropriate permissions.

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 these 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 errors or empty results.
  • API Authentication Errors: If the API token or secret is incorrect or missing, the node will fail with authentication errors.
  • Network Issues: Network connectivity problems will result in network error messages.
  • API Errors: The node surfaces API error messages returned by OnOffice, which can indicate issues like invalid parameters or resource not found.

To resolve errors:

  • Verify all required properties are set and valid.
  • Check API credentials and permissions.
  • Confirm network connectivity.
  • Review error messages for specific API feedback.

Links and References

Discussion