OnOffice

Consume OnOffice API

Actions12

Address → Get Many

AI-generated

Overview

This node interacts with the OnOffice API to retrieve multiple address records based on specified criteria. It is designed to fetch a list of addresses, optionally filtered and paginated, returning selected fields for each address.

Common scenarios where this node is beneficial include:

  • Synchronizing address/contact data from OnOffice into other systems.
  • Retrieving filtered lists of contacts for marketing or communication purposes.
  • Exporting address data with specific fields for reporting or analysis.

For example, you can use this node to get up to 50 addresses that match certain filter criteria (e.g., city or postal code) and only return their ID, name, first name, and email fields.

Properties

Name Meaning
Fields Comma-separated list of address fields to return. Example: id,name,vorname,email
Additional Fields Collection of optional parameters:
- Filter JSON object defining filter criteria to narrow down the query results. Must be valid JSON.
- Limit Maximum number of address records to return (default 50).
- Offset Number of records to skip before starting to collect the result set (for pagination).

Output

The output is a JSON array where each item contains:

  • success: Boolean indicating if the operation was successful.
  • resourceType: The resource type, here always "address".
  • operation: The operation performed, here "getMany".
  • data: An array of address records matching the query, each containing the requested fields.
  • total (optional): Total number of matching records available (from metadata).

If an error occurs and "Continue On Fail" is enabled, the output will contain items with:

  • success: false
  • error: Error message describing the failure
  • resourceType and operation for context

No binary data is output by this node.

Dependencies

  • Requires an API token and secret credential for authenticating with the OnOffice API.
  • The node uses HTTP POST requests to the OnOffice API endpoint https://api.onoffice.de/api/v1.
  • Proper configuration of the API credentials in n8n is necessary.
  • The filter property must be valid JSON if used.

Troubleshooting

  • Invalid JSON in Filter: If the filter JSON is malformed, the node throws an error "Filter must be a valid JSON". Ensure the filter string is correctly formatted JSON.
  • API Authentication Errors: If the API token or secret is incorrect or missing, the node will fail with an authentication error. Verify credentials are properly set.
  • Network Issues: Network errors during the HTTP request will cause the node to throw a "Network error" message.
  • Unsupported Resource or Operation: Using unsupported combinations will result in errors indicating the resource or operation is not supported.
  • Data Parsing Errors: If the fields parameter or other inputs are invalid, the node may throw errors. Double-check input formats.

Enabling "Continue On Fail" allows the workflow to proceed even if some items fail.

Links and References

Discussion