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 city matches a certain value, 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 API call 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 and "Continue On Fail" is enabled, the output will contain objects with:

  • 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, specifically an API token and secret.
  • The node makes HTTP POST requests to the OnOffice API endpoint at https://api.onoffice.de/api/latest/api.php.
  • Proper configuration of the API credentials within n8n is necessary.

Troubleshooting

  • Invalid JSON in Filter: If the filter field contains invalid JSON, 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 are incorrect or missing, the node will fail with an authentication error from the OnOffice API.
  • Network Issues: Network errors during the HTTP request will cause the node to throw a network error message.
  • Unsupported Resource or Operation: If the resource or operation parameters are set incorrectly, the node will report that the resource or operation is not supported.
  • Data Parsing Errors: For operations requiring JSON input (not applicable here but relevant for create/update), invalid JSON will cause errors.

To resolve these issues:

  • Validate JSON inputs carefully.
  • Verify API credentials and permissions.
  • Check network connectivity.
  • Use correct resource and operation combinations.

Links and References

Discussion