OnOffice

Consume OnOffice API

Actions12

Overview

This node integrates with the OnOffice API to manage address records. Specifically, for the "Address" resource and the "Get Many" operation, it retrieves multiple address entries from the OnOffice system based on specified criteria. This is useful when you want to fetch a list of contacts or addresses with filtering, pagination, and selective fields.

Common scenarios include:

  • Retrieving a filtered list of contacts for marketing or outreach.
  • Exporting address data for reporting or synchronization with other systems.
  • Paginating through large sets of address records in batches.

Example: You might use this node to get up to 50 addresses where the email field is not empty, returning only the id, name, first name, and email fields.

Properties

Name Meaning
Fields Comma-separated list of fields to return for each address record (e.g., 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 results to return (default 50).
- Offset Number of results to skip before starting to collect the output (default 0).

Output

The node outputs a JSON array where each item contains:

  • success: Boolean indicating if the request was successful.
  • resourceType: The resource queried, 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 count of matching records available (if provided by the API).

No binary data output is produced by this operation.

Dependencies

  • Requires an API token and secret for authenticating with the OnOffice API.
  • The node uses HMAC signature authentication for requests.
  • The base URL for the API is https://api.onoffice.de/api/v1.
  • Proper credentials must be configured in n8n prior to using this node.

Troubleshooting

  • Invalid JSON in Filter: If the filter property is not valid JSON, the node throws an error "Filter must be a valid JSON". Ensure your filter string is correctly formatted JSON.
  • API Authentication Errors: If the API token or secret are incorrect or missing, requests will fail. Verify credentials in n8n settings.
  • Network Errors: Network issues or unreachable API endpoints result in errors like "Network error: ...". Check your internet connection and API availability.
  • Unsupported Resource or Operation: Using unsupported combinations will throw errors indicating the resource or operation is not supported.
  • Data Parsing Errors: For create or update operations (not relevant here), invalid JSON in the data field causes errors.

Links and References

Discussion