onOffice

Consume onOffice API

Actions10

Overview

This node integrates with the onOffice API to perform search operations, specifically allowing users to search for addresses or estates. For the Search - Address operation, it enables searching address records using either simple keyword searches or advanced criteria filters. This is useful in scenarios where you want to find contact or client address information stored in onOffice based on flexible search parameters.

Practical examples include:

  • Quickly finding an address by entering a keyword such as a name or street.
  • Using advanced filters like city or postal code to narrow down address results.
  • Limiting the number of returned results to manage data volume.

Properties

Name Meaning
Search Type Type of search to perform:
• Simple — Search with simple keywords
• Advanced — Search with advanced criteria
Keywords (Simple search only) The keywords string used to search addresses
Search Criteria (Advanced search only) A set of detailed criteria to filter the search results. Includes fields like Minimum Price, Maximum Price, City, Postal Code, Estate Type, and Status. Note: Some criteria are specific to estate searches and may not apply to address searches.
Limit Maximum number of results to return

Output

The node outputs an array of JSON objects representing the search results. Each item corresponds to one matched address record containing fields such as customer number, salutation, first name, last name, phone, email, street, postal code, city, country, and user.

If no results are found, the output will contain the raw API response or an empty result set.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the onOffice API.
  • The node uses HMAC SHA256 signing for request authentication, requiring both an API token and secret.
  • Network access to https://api.onoffice.de/api/stable/api.php is necessary.

Troubleshooting

  • No credentials provided: The node will throw an error if the required API credentials are missing. Ensure that valid API authentication tokens are configured in n8n.
  • Invalid resource or operation: If the selected resource or operation is unsupported, an error is thrown. Verify that "Search" resource and "Address" operation are correctly selected.
  • API errors: If the API returns an error status, the node surfaces the message. Common causes include invalid parameters or expired credentials. Check the API token validity and parameter correctness.
  • Empty results: If no matching addresses are found, verify the search keywords or criteria for accuracy.

Links and References

Discussion