OnOffice

Consume OnOffice API

Actions12

Overview

This node integrates with the OnOffice API to manage real estate-related data, specifically focusing on relations between estates and addresses (contacts). The "Get" operation for the "Relation" resource retrieves detailed information about a specific relation by its ID. This is useful when you want to fetch the connection details between an estate and a contact, such as owner, tenant, or interested party.

Common scenarios:

  • Fetching the details of a particular relation to display or process in workflows.
  • Integrating OnOffice relation data into CRM or property management systems.
  • Automating updates or notifications based on relation information.

Example:
You have a workflow that triggers when a new relation is created or updated in OnOffice. Using this node's "Get Relation" operation, you retrieve the full details of that relation to enrich your database or send customized emails.

Properties

Name Meaning
Relation ID The unique identifier of the relation to retrieve or delete.
Fields Comma-separated list of fields to return from the relation record. Defaults to id,type,estateid,addressid.

Output

The node outputs JSON data containing the result of the API call. For the "Get Relation" operation, the output structure includes:

  • success: Boolean indicating if the operation was successful.
  • resourceType: The resource involved, here always "relation".
  • operation: The operation performed, here "get".
  • data: An array of relation records matching the query, each containing the requested fields.
  • total (optional): Total number of records returned (present if metadata is available).

Example output JSON snippet:

{
  "success": true,
  "resourceType": "relation",
  "operation": "get",
  "data": [
    {
      "id": "12345",
      "type": "owner",
      "estateid": "67890",
      "addressid": "54321"
    }
  ],
  "total": 1
}

No binary data output is produced by this node.

Dependencies

  • Requires an active OnOffice API credential with an API token and secret.
  • The node uses the OnOffice REST API endpoint at https://api.onoffice.de/api/latest/api.php.
  • Proper configuration of the API credentials in n8n is necessary for authentication and HMAC signature generation.

Troubleshooting

  • Invalid JSON in Filters: If using filters in additional fields (not applicable for "Get" single relation but relevant for other operations), ensure the filter JSON is valid; otherwise, a validation error will occur.
  • Missing or Incorrect Relation ID: The "Relation ID" property is required. Omitting it or providing an invalid ID will cause the API to return an error.
  • API Errors: Errors from the OnOffice API are surfaced with messages like OnOffice API error: <message>. Check the message for details such as invalid credentials, permission issues, or non-existent IDs.
  • Network Issues: Network errors will be reported as Network error: <message>. Verify network connectivity and API endpoint accessibility.
  • Unsupported Resource or Operation: The node throws errors if an unsupported resource or operation is selected, but this should not happen if the UI options are used correctly.

Links and References

Discussion