OnOffice

Consume OnOffice API

Actions12

Overview

This node integrates with the OnOffice API to manage address records. Specifically, the "Get Many" operation for the "Address" resource allows users to retrieve multiple address entries from their OnOffice account. It supports filtering, pagination (limit and offset), and selecting specific fields to return.

Common scenarios include:

  • Fetching a list of contacts or addresses matching certain criteria.
  • Retrieving paginated address data for display or further processing.
  • Selecting only relevant fields to optimize data handling.

For example, a user might want to get up to 100 addresses where the city is "Berlin", returning only the name, email, and phone number 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 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:

  • 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 structure:

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

No binary data is returned by this node.

Dependencies

  • Requires an API token and secret credential for authenticating with the OnOffice API.
  • The node makes HTTP POST requests to the OnOffice stable API endpoint (https://api.onoffice.de/api/stable/api.php).
  • HMAC signature generation is used for request authentication.
  • Proper configuration of the API credentials in n8n is necessary.

Troubleshooting

  • Invalid JSON in Filter or Data fields: If the filter or data input is not valid JSON, the node throws an error stating "Filter must be a valid JSON" or "Data must be a valid JSON". Ensure these inputs are correctly formatted JSON strings.
  • API errors: If the OnOffice API returns an error, the node surfaces the message prefixed with "OnOffice API error:". Check the API credentials and the correctness of parameters.
  • Network issues: Network errors will be reported as "Network error: ...". Verify network connectivity and API endpoint accessibility.
  • Unsupported operations or resources: Errors like "The operation '...' is not supported for resource '...'" indicate misconfiguration of the node parameters.
  • Pagination limits: Setting very high limits may cause performance issues or API rejections; use reasonable values.

Links and References

Discussion