OnOffice

Consume OnOffice API

Actions12

Estate Actions
Address Actions
Relation Actions

Address → Get

AI-generated

Overview

This node integrates with the OnOffice API to manage real estate-related data. Specifically, for the Address - Get operation, it retrieves detailed information about a single address record by its unique ID. This is useful when you need to fetch contact or location details associated with estates or relations in your real estate workflows.

Common scenarios:

Fetching contact details of an address linked to a property.
Retrieving specific fields of an address for reporting or further processing.
Integrating address data into CRM or marketing automation systems.

Practical example:
You have an estate record and want to get the full address details of the owner or tenant. Using this node, you provide the address ID and specify which fields to retrieve (e.g., name, email), then use the output to update your contact database.

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. Default: `id,name,vorname,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: An array of records returned by the API. For the "Get" operation, this typically contains one address object with the requested fields.
total (optional): Total number of records, present if metadata is returned.

Example output JSON snippet:

{
  "success": true,
  "resourceType": "address",
  "operation": "get",
  "data": [
    {
      "id": "12345",
      "name": "Doe",
      "vorname": "John",
      "email": "john.doe@example.com"
    }
  ]
}

No binary data output is produced by this operation.

Dependencies

Requires an API key credential for authenticating with the OnOffice API.
The node uses the OnOffice REST API endpoint at https://api.onoffice.de/api/v1.
Proper configuration of the API token and secret is necessary.
The node internally generates HMAC signatures for request authentication.

Troubleshooting

Invalid ID or missing record: If the provided ID does not exist, the API may return an error or empty data. Verify the ID correctness.
Malformed Fields parameter: The Fields input must be a comma-separated string without invalid characters. Incorrect formatting might cause unexpected results.
Invalid JSON in other operations: Although not relevant for "Get", other operations require valid JSON in inputs; errors will mention JSON validity.
API errors: Errors from the OnOffice API are surfaced with messages like OnOffice API error: <message>. Check API credentials and network connectivity.
Network issues: Network failures result in messages like Network error: <message>. Ensure internet access and correct endpoint URL.

If the node is set to continue on failure, errors will be included in the output JSON with success: false and an error message.

Links and References

OnOffice API Documentation (official API docs)
n8n documentation on Creating Custom Nodes
General info on HMAC Authentication

This summary covers the static analysis of the Address resource's Get operation based on the provided source code and properties.

OnOfficeInstall