OnOffice

Consume OnOffice API
Join our community

Actions12

Overview

This node integrates 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, returning only their ID, name, first name, and email fields.

Properties

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

Output

The output is a JSON array where each item contains:

  • success: Boolean indicating if the operation succeeded.
  • 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 (if provided by the API).

If an error occurs and "Continue On Fail" is enabled, the output will contain items with success: false and an error message describing the issue.

No binary data is produced by this node.

Dependencies

  • Requires an API token and secret for authenticating with the OnOffice API.
  • Needs the OnOffice API credentials configured in n8n.
  • Uses the OnOffice REST API endpoint at https://api.onoffice.de/api/latest/api.php.

Troubleshooting

  • Invalid JSON in Filter: If the filter field contains invalid JSON, the node throws an error stating "Filter must be a valid JSON". Ensure the filter input is correctly formatted JSON.
  • API Authentication Errors: If the API token or secret are incorrect or missing, requests will fail. Verify that the OnOffice API credentials are properly set up.
  • Network Issues: Network errors during the HTTP request will result in a "Network error" message. Check your internet connection and API availability.
  • Unsupported Resource or Operation: Using unsupported combinations of resource and operation will cause errors indicating the resource or operation is not supported.
  • Data Field Parsing: For create or update operations (not relevant here), invalid JSON in the data field causes errors. Make sure JSON inputs are valid.

Links and References

Discussion