Actions14
Overview
This node integrates with the onOffice API to retrieve detailed information about addresses (contacts) stored in the onOffice system. Specifically, the Address - Get operation fetches data for a single address/contact by its unique ID. This is useful when you need to access or process contact details such as names, phone numbers, email addresses, and location information within an automation workflow.
Common scenarios:
- Fetching contact details before sending personalized emails or notifications.
- Retrieving user or customer information to enrich CRM records.
- Accessing address data to validate or update external databases.
Example:
You have a workflow that triggers when a new lead is added. Using this node, you can get the full contact details of that lead by their Address ID and then use those details to send a welcome message or create a task for follow-up.
Properties
| Name | Meaning |
|---|---|
| Address ID | The unique identifier of the address/contact to retrieve. This is required to specify which contact to fetch. |
| Fields to Retrieve | Select which fields to retrieve for the address. Options include: |
| - Customer Number (KdNr) | |
| - Salutation (Anrede) | |
| - First Name (Vorname) | |
| - Last Name (Name) | |
| - Phone (Telefon1) | |
| - Secondary Phone (Telefon2) | |
| - Street (Strasse) | |
| - Postal Code (Plz) | |
| - City (Ort) | |
| - Country (Land) | |
| - User responsible for this contact (Benutzer) |
The "Fields to Retrieve" property allows selecting multiple fields to customize the data returned from the API.
Output
The node outputs JSON data representing the requested address/contact fields. The structure includes:
- Each output item corresponds to one address record.
- The
jsonobject contains key-value pairs where keys are field names (e.g., "Vorname" for first name, "Email" for email). - An additional property
resourceTypeis set to"address"to indicate the type of resource returned. - If no results are found or the response cannot be parsed, the output will contain a success message with the raw API response.
- In case of errors, the output may contain error messages if "Continue On Fail" is enabled.
No binary data is produced by this operation.
Dependencies
- Requires an API authentication token and secret credential for the onOffice API.
- The node makes HTTP POST requests to the onOffice stable API endpoint:
https://api.onoffice.de/api/stable/api.php. - HMAC SHA256 signing is used to authenticate each request using the API token and secret.
- Proper configuration of the onOffice API credentials in n8n is necessary.
Troubleshooting
- No credentials provided: The node will throw an error if the API credentials are missing. Ensure the API token and secret are configured correctly.
- Invalid Resource or Operation: If the resource or operation parameters are incorrect, an error will be thrown indicating invalid input.
- API Errors: If the API returns a non-200 status code, the node throws an error with the API's message. Check the API token validity and permissions.
- Empty or malformed response: If the API response does not contain expected data, the node outputs a message indicating no results or parsing failure.
- Field selection issues: Selecting fields not available or misspelled may result in incomplete data. Use only supported field names listed in the properties.
- Rate limits or network issues: Network failures or API rate limiting can cause errors; retry or check connectivity.
Links and References
- onOffice API Documentation (official API docs)
- HMAC SHA256 Authentication (general info on request signing)
- n8n Documentation (for configuring credentials and workflows)