OnOffice

Consume OnOffice API

Actions12

Estate Actions
Address Actions
Relation Actions

Overview

This node integrates with the OnOffice API to manage real estate-related data, specifically focusing on relations between estates and addresses (contacts). The Relation - Get operation retrieves detailed information about a specific relation by its ID. This is useful when you want to fetch metadata or attributes of a particular relationship, such as ownership or tenancy, linking an estate to a contact.

Common scenarios:

Fetching details of a property-owner relation.
Retrieving tenant information linked to a specific estate.
Accessing contact roles related to real estate assets.

Practical example:
You have a property management workflow where you need to pull the current owner’s contact details for a given estate. Using this node with the Relation resource and Get operation, you provide the relation ID, and it returns the relevant fields like relation type, estate ID, and address ID.

Properties

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

Output

The output JSON contains the following structure:

success: Boolean indicating if the API call was successful.
resourceType: The resource involved, here always "relation".
operation: The operation performed, here "get".
data: An array of relation records matching the query (usually one item for "get" by ID).
total: (optional) Total number of records returned (mainly for getMany operations).
message: A status message from the API response (present in some cases).

Example output snippet:

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

No binary data is produced by this node.

Dependencies

Requires an active connection to the OnOffice API.
Needs an API authentication token and secret configured in n8n credentials.
Uses HTTP POST requests to the OnOffice API endpoint https://api.onoffice.de/api/latest/api.php.

Troubleshooting

Invalid Relation ID: If the provided relation ID does not exist or is malformed, the API will return an error. Verify the ID is correct.
Invalid Fields Format: The Fields parameter must be a comma-separated string without syntax errors.
API Authentication Errors: Ensure that the API token and secret are correctly set up in the node credentials.
Network Issues: Network failures or timeouts will cause errors; check connectivity and API availability.
JSON Parsing Errors: Although not typical for the Get operation, other operations require valid JSON input; invalid JSON will throw errors.

Common error messages:

"OnOffice API error: <message>" — Indicates an issue reported by the OnOffice API, often due to invalid parameters or authentication.
"Network error: <message>" — Indicates network-level problems connecting to the API.

To resolve errors, verify all input parameters, credentials, and network conditions.

Links and References

OnOffice API Documentation (official API docs)
n8n documentation on Creating Custom Nodes
JSON formatting guidelines for input fields

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

OnOfficeInstall