Actions15
Overview
This node integrates with the OnOffice API to manage real estate-related data. Specifically, for the Address - Get operation, it retrieves detailed information about a single address record by its unique ID. This is useful when you need to fetch contact details or other address-related information stored in the OnOffice system.
Common scenarios include:
- Fetching customer or contact details for follow-up communications.
- Retrieving address information to populate forms or CRM systems.
- Accessing specific fields of an address record for reporting or automation workflows.
Example: You want to get the full details of a client’s address by providing their unique ID and selecting which fields (e.g., first name, last name, email, phone) to return.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the address record to retrieve. |
| Fields | The list of address fields to return. Options include: Customer Number, Form of Address, First Name, Last Name, Email, Phone 1, Phone 2, Mobile, Street, Postal Code, City, Country, User, Creation Date, Last Change Date. Default selection includes common contact fields like Customer Number, Name, Email, Phone 1, Street, Postal Code, and City. |
Output
The output JSON contains the following structure:
success: Boolean indicating if the API call was successful.resourceType: The resource type, here always"address".operation: The operation performed, here"get".data: An object or array containing the requested address record(s) with the selected fields.total(optional): Total number of records returned (mainly for multi-record queries).message(optional): Status message from the API.rawResponse: The full raw response from the OnOffice API for debugging purposes.
If the node encounters an error, the output will contain error details including the error message and any API error response.
The node does not output binary data for this operation.
Dependencies
- Requires an API authentication token and secret credential for the OnOffice API.
- The node sends HTTP POST requests to the OnOffice API endpoint at
https://api.onoffice.de/api/latest/api.php. - HMAC signature generation is used for request authentication.
- Proper configuration of the OnOffice API credentials in n8n is necessary.
Troubleshooting
- Invalid JSON Data: When creating or updating, the node expects valid JSON in the "Data" property. Invalid JSON will cause an error.
- Missing Required ID: The "ID" property is required for the Get operation; omitting it will cause failure.
- API Request Failed: Network issues or invalid credentials can cause the API request to fail. Check your API token and secret.
- API Action Errors: If the API returns an error code, the node surfaces the error message. Verify that the ID exists and the fields requested are valid.
- Continue on Fail: If enabled, the node will continue processing subsequent items even if one fails, returning error details in the output.
Links and References
- OnOffice API Documentation (general reference, actual URL may vary)
- n8n documentation on Creating Custom Nodes
- HMAC Authentication concepts for API security
This summary focuses on the Address - Get operation as requested, describing how to retrieve a single address record by ID with selectable fields.