OnOffice

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 string 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 request was successful.
• resourceType: The resource involved, 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).

If an error occurs, the output will contain:

• success: false
• error: Error message describing what went wrong.
• resourceType and operation for context.

No binary data is output by this node.

Dependencies

• Requires valid credentials for the OnOffice API, including an API token and secret.
• The node uses HMAC signature authentication for API requests.
• Network access to https://api.onoffice.de/api/v1 is required.

Troubleshooting

• Invalid JSON in Filter: If the filter JSON is malformed, the node throws an error "Filter must be a valid JSON". Ensure your filter string is properly formatted JSON.
• Invalid JSON in Data: For create/update operations (not relevant here), invalid JSON in the data property causes errors.
• API Errors: If the OnOffice API returns an error, the node surfaces the message, e.g., "OnOffice API error: ". Check your API credentials and request parameters.
• Network Issues: Network failures result in "Network error" messages. Verify connectivity and endpoint availability.
• Unsupported Resource/Operation: Using unsupported combinations will throw descriptive errors.

Links and References

• OnOffice API Documentation (official API docs, for detailed field and filter info)
• n8n documentation on HTTP Request Node (for understanding HTTP interactions)

---

If you need details on other resources or operations, feel free to ask!