OnOffice icon

OnOffice

Consume OnOffice API

Actions30

Overview

This node integrates with the OnOffice API to perform various operations on different resource types such as estates, addresses, relations, tasks, and agent logs. Specifically, for the Address resource with the Get operation, it retrieves a single address record by its unique ID.

Common scenarios where this node is useful include:

  • Fetching detailed address information for real estate listings.
  • Integrating address data into workflows that require location details.
  • Automating retrieval of address records for reporting or synchronization with other systems.

For example, you might use this node to get the full address details of a property by providing its ID, then use that data downstream in your workflow to enrich customer communications or update a CRM system.

Properties

Name Meaning
ID The unique identifier of the address record to retrieve. This is required for the Get operation.
Include Debug Info Boolean flag to include detailed debug information in the output, such as raw API response and request details. Useful for troubleshooting.

Output

The node outputs JSON data structured as follows:

  • When Include Debug Info is false (default), the output JSON contains:
    {
  "success": true,
  "resourceType": "address",
  "operation": "get",
  "data": [ /* array with the retrieved address record(s) */ ]
}
  • When Include Debug Info is true, the output JSON includes additional fields:
    {
  "debug": true,
  "rawResponse": { /* full raw API response object */ },
  "requestSent": { /* full request payload sent to the API */ },
  "url": "https://api.onoffice.de/api/latest/api.php"
}

If an error occurs and the node is set to continue on failure, the output will contain:

{
  "success": false,
  "error": "Error message describing what went wrong",
  "resourceType": "address",
  "operation": "get"
}

The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the OnOffice API. This credential must provide an API token and secret.
  • Uses the OnOffice API endpoint: https://api.onoffice.de/api/latest/api.php for most resources including Address.
  • The node internally generates HMAC signatures for secure API requests using the provided credentials.
  • No additional external dependencies beyond the OnOffice API and n8n's HTTP request helper.

Troubleshooting

Common Issues

  • Invalid or missing ID: The node requires a valid ID string to fetch the address record. Omitting or providing an incorrect ID will cause the API to return an error.
  • Authentication errors: If the API token or secret are invalid or expired, the API will reject the request.
  • API rate limits or downtime: Temporary failures from the OnOffice API may cause errors.
  • Incorrect resource or operation selection: Using unsupported combinations may lead to unexpected errors.

Error Messages

  • "OnOffice API error: <message>": Indicates the API returned an error status. Check the message for details such as invalid ID or authentication failure.
  • "Unknown error": Generic fallback if no specific error message is returned by the API.

Resolution Tips

  • Verify the ID value is correct and corresponds to an existing address record.
  • Ensure the API credentials are correctly configured and have necessary permissions.
  • Enable Include Debug Info to get detailed request and response data for diagnosing issues.
  • Use the node's "Continue on Fail" option to handle errors gracefully in workflows.

Links and References

Discussion