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 specific fields and optional filtering, pagination, or limits.

Practical examples include:

  • Retrieving a list of client addresses filtered by certain attributes.
  • Fetching a paginated set of addresses for batch processing or reporting.
  • Selecting only specific fields (e.g., name, email) to optimize data transfer and processing.

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 for the query.
- Limit: Maximum number of results to return (default 50).
- Offset: Number of results to skip before starting to collect the result set (default 0).

Output

The output is a JSON array where each item contains an object with the following structure:

  • 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 number of matching records available (from metadata).

Example output snippet:

{
  "success": true,
  "resourceType": "address",
  "operation": "getMany",
  "data": [
    {
      "id": "123",
      "name": "Doe",
      "vorname": "John",
      "email": "john.doe@example.com"
    },
    ...
  ],
  "total": 150
}

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 signatures for request authentication.
  • Network access to https://api.onoffice.de/api/latest/api.php is required.
  • Proper configuration of credentials in n8n is necessary to provide the API token and secret.

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 input is correctly formatted JSON.
  • API Authentication Errors: Errors related to invalid or missing API tokens will cause the API to reject requests. Verify that the API credentials are correctly configured.
  • Network Issues: Network errors during the HTTP request will throw a "Network error" message. Check internet connectivity and API endpoint availability.
  • Unknown API Errors: If the API returns an error status, the node surfaces the message from the API response. Review the message for details and adjust parameters accordingly.
  • Field Names: Requesting fields not supported by the API may lead to incomplete or empty data. Confirm field names are valid according to OnOffice API documentation.

Links and References

Discussion