onOffice icon

onOffice

Consume onOffice API

Actions14

Overview

This node integrates with the onOffice API to retrieve address data in bulk. Specifically, the Address - Get All operation fetches multiple address records from the onOffice system, supporting filtering and sorting options. This is useful for workflows that need to process or analyze large sets of contact information such as clients, leads, or partners stored in onOffice.

Common scenarios include:

  • Exporting filtered address lists based on criteria like first name, last name, phone number, or email.
  • Synchronizing address data with other systems by retrieving all relevant contacts.
  • Generating reports or mailing lists sorted by specific fields such as last name or customer number.

Example: Retrieve up to 50 addresses where the first name contains "John", sorted by last name ascending.

Properties

Name Meaning
Limit Maximum number of address records to return (minimum 1).
Filters Collection of filters to narrow down results:
- First Name: Filter addresses by first name (partial match).
- Last Name: Filter addresses by last name (partial match).
- Phone Number: Filter addresses by phone number (exact or partial match depending on format).
- Phone Field Name: API field name used for phone filtering (default: "Telefon1").
- Email: Filter addresses by email (partial match).
- Email Field Name: API field name used for email filtering (default: "Email").
Options Additional options for result customization:
- Sort by: Field to sort results by. Options are First Name, Last Name, Customer Number, Email.
- Sort Direction: Direction to sort results, either Ascending or Descending.

Output

The output is an array of JSON objects representing individual address records retrieved from onOffice. Each record includes fields such as:

  • KdNr (Customer Number)
  • Anrede (Salutation)
  • Vorname (First Name)
  • Name (Last Name)
  • Telefon1, Telefon2 (Phone numbers)
  • Email
  • Strasse (Street)
  • Plz (Postal Code)
  • Ort (City)
  • Land (Country)
  • Benutzer (User)

Additionally, each output item includes a resourceType property set to "address" to identify the type of data.

If no results are found or the response cannot be parsed, the node outputs a success message indicating no results.

The node does not output binary data.

Dependencies

  • Requires valid credentials for the onOffice API, including an API token and secret.
  • The node makes HTTP POST requests to the onOffice stable API endpoint (https://api.onoffice.de/api/stable/api.php).
  • HMAC SHA256 signing is used for request authentication.
  • Requires n8n credential configuration with appropriate API access.

Troubleshooting

  • No credentials provided: The node will throw an error if API credentials are missing. Ensure you have configured the required API key and secret in n8n credentials.
  • Invalid resource or operation: If the resource or operation parameters are incorrect, the node throws an error. Verify you selected "Address" as resource and "Get All" as operation.
  • API Error with status code != 200: Indicates the onOffice API returned an error. Check the error message for details, verify your API token validity, and ensure your request parameters are correct.
  • No results found: This is not an error but indicates no matching addresses were found for the given filters.
  • Filtering issues: Make sure filter field names correspond to the actual API field names, especially for phone and email fields which can be customized.
  • Rate limits or network errors: Standard HTTP request failures may occur; check network connectivity and API rate limits.

Links and References

Discussion