OnOffice

Consume OnOffice API

Actions12

Estate Actions
Address Actions
Relation Actions

Relation → Get

AI-generated

Overview

This node integrates with the OnOffice API to manage "Relation" resources, which represent relationships between estates and addresses (contacts). The Get operation retrieves detailed information about a specific relation by its ID. This is useful when you want to fetch data about how a particular contact is related to an estate, such as owner, tenant, or interested party.

Common scenarios:

Fetching details of a specific relation to display or process in workflows.
Integrating OnOffice relations data into CRM or property management systems.
Automating notifications or updates based on relation data changes.

Example:
You have a workflow that triggers when a new relation is created or updated in OnOffice. Using this node's Get operation, you retrieve the full details of that relation by its ID to enrich your records or trigger further actions.

Properties

Name	Meaning
Relation ID	The unique identifier of the relation to retrieve.
Fields	Comma-separated list of fields to return for the relation. Default: `id,type,estateid,addressid`

Output

The node outputs JSON data containing the requested relation information. The structure includes:

success: Boolean indicating if the request was successful.
resourceType: The resource type, here always "relation".
operation: The operation performed, here "get".
data: An array of relation records matching the query. For the Get operation, this typically contains one record with the requested fields.
total (optional): Total number of records returned (mainly relevant for getMany operations).
message (optional): Status message from the API.

Example output JSON snippet:

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

No binary data output is produced by this node.

Dependencies

Requires an API token and secret credential for authenticating with the OnOffice API.
The node uses HMAC signatures for request authentication.
Network access to https://api.onoffice.de/api/v1 is required.
No additional external dependencies beyond the OnOffice API and n8n credentials.

Troubleshooting

Invalid JSON in Filters or Data: If you provide filter criteria or data fields as JSON strings, ensure they are valid JSON. Invalid JSON will cause errors.
Missing or Incorrect Relation ID: The Relation ID is required for the Get operation. Omitting it or providing an invalid ID will result in API errors.
API Authentication Errors: Ensure the API token and secret are correctly configured in the node credentials. Authentication failures will prevent data retrieval.
Network Issues: Connectivity problems to the OnOffice API endpoint will cause network errors.
API Error Messages: The node surfaces error messages returned by the OnOffice API. Review these messages for clues on issues like permission problems or invalid parameters.

If the node encounters an error and "Continue On Fail" is enabled, it will output an object with success: false and the error message instead of stopping the workflow.

Links and References

OnOffice API Documentation (official API docs)
n8n Documentation - Creating Custom Nodes
HMAC Authentication Explanation

If you need details on other operations or resources, feel free to ask!

OnOfficeInstall