OnOffice

Consume OnOffice API
Join our community

Actions12

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 address details stored in the OnOffice system.

Common scenarios include:

  • Fetching contact details of a client or tenant associated with a property.
  • Retrieving address information for mailing or communication purposes.
  • Integrating address data into workflows that require up-to-date contact info from OnOffice.

Example: You have an address ID and want to get the name, first name, and email fields of that contact to send a personalized email.

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 type, here always "address".
  • operation: The operation performed, here "get".
  • data: An array of records returned by the API. For the "Get" operation, this will typically contain one address object with the requested fields.
  • total (optional): Total number of records found (mainly relevant for "getMany" operations).
  • message (optional): Status message from the API.

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 is output by this node.

Dependencies

  • Requires an active connection to the OnOffice API.
  • Needs an API token and secret configured as credentials within n8n.
  • Uses the OnOffice API endpoint at https://api.onoffice.de/api/latest/api.php.

Troubleshooting

  • Invalid ID or Record Not Found: If the provided ID does not exist, the API may return an error or empty data. Verify the ID is correct.
  • Invalid Fields Format: The Fields input must be a comma-separated string without syntax errors. Incorrect formatting can cause API errors.
  • API Authentication Errors: Ensure the API token and secret are valid and have sufficient permissions.
  • Filter Parsing Errors: Although not applicable for the "Get" operation, other operations use JSON filters; invalid JSON will throw errors.
  • Network Issues: Network failures or timeouts will result in errors; check connectivity and API availability.

Error messages from the API are surfaced clearly, e.g., "OnOffice API error: <message>". Network issues show "Network error: <message>".

Links and References

Discussion