OnOffice icon

OnOffice

Consume OnOffice API

Actions15

Overview

This node interacts with the OnOffice API to retrieve IDs related by a specific type of relation between estates and addresses. Specifically, for the "IDs From Relation" resource with the "Get" operation, it fetches either estate IDs related to a given address or address IDs related to a given estate, filtered by a specified relation type such as Owner, Tenant, Interested Party, or Contact.

Common scenarios include:

  • Finding all addresses associated with a particular estate under a certain relationship (e.g., all tenants of an estate).
  • Finding all estates linked to a specific address/contact by a defined relation type.
  • Useful in real estate management workflows where relations between properties and contacts need to be queried efficiently.

Example use case:

  • Given an estate ID, retrieve all tenant address IDs to send targeted communications.
  • Given a contact's address ID, find all estates they are interested in or own.

Properties

Name Meaning
Relation Type Type of relation between estate and address. Options: Owner, Tenant, Interested Party, Contact.
ID Type Whether to find estates from an address or addresses from an estate. Options: Estate, Address.
ID The ID of the estate or address to find relations for (required).

Output

The output JSON contains the following structure:

  • success: Boolean indicating if the API call was successful.
  • resourceType: The resource used, here always "idsfromrelation".
  • operation: The operation performed, here always "get".
  • data: An array of IDs corresponding to the related estates or addresses depending on the idType parameter.
  • total: (Optional) Total count of related records if available.
  • status / message: Status information or messages returned from the API.
  • rawResponse: The full raw response from the OnOffice API for debugging purposes.

If the API request fails, the output includes error details such as error, errorMessage, and optionally the API error response.

No binary data is output by this node.

Dependencies

  • Requires an API token credential for authenticating with the OnOffice API.
  • The node makes HTTP POST requests to the OnOffice API endpoint at https://api.onoffice.de/api/latest/api.php.
  • HMAC signature generation is used for request authentication, requiring both an API token and secret.
  • No additional external dependencies beyond the OnOffice API and n8n's HTTP request helper.

Troubleshooting

  • Invalid or missing ID: The ID property is required; ensure it is provided and valid.
  • Incorrect relation type: Use one of the predefined relation types; otherwise, the API may return no results or errors.
  • API authentication errors: Verify that the API token and secret credentials are correctly configured.
  • Malformed JSON or unexpected API responses: The node returns detailed error messages including API response content to help diagnose issues.
  • Rate limits or network errors: These will cause API request failures; check connectivity and API usage limits.
  • If the node throws an error like OnOffice API action error or API Request Failed, review the error message and ensure parameters and credentials are correct.

Links and References

Discussion