onOffice

Interact with onOffice API

Actions10

Overview

This node interacts with the onOffice API to manage address data. Specifically, the Address - Get operation retrieves detailed information about a single address record by its ID. It allows users to specify which fields of the address they want to include in the response, enabling tailored data retrieval.

Common scenarios where this node is beneficial include:

  • Fetching contact details for a specific client or customer.
  • Retrieving address information to populate forms or CRM systems.
  • Integrating address data into workflows that require up-to-date contact info.

For example, you might use this node to get the email and phone number of a particular address entry before sending a notification or updating another system.

Properties

Name Meaning
Address ID The unique identifier of the address to retrieve.
Fields Select which fields to include in the response. Options: ID, Customer Number, First Name, Last Name, Company Name, Email, Phone, Mobile, Street, Postal Code, City, Country, Birthday, Created Date, Modified Date, Status. Default selection includes ID, First Name, Last Name, and Email.

Output

The output JSON contains the requested address data fields as returned by the onOffice API. The structure corresponds directly to the selected fields, such as:

{
  "Id": "12345",
  "Vorname": "John",
  "Name": "Doe",
  "Email": "john.doe@example.com",
  ...
}

Each key matches the field names used by the API (e.g., Vorname for first name, Name for last name). The node does not output binary data for this operation.

Dependencies

  • Requires an active connection to the onOffice API via an API key credential configured in n8n.
  • The node sends POST requests to the /api.php endpoint of the onOffice API.
  • Proper API authentication credentials must be set up in n8n for successful requests.

Troubleshooting

  • Error: Invalid or missing Address ID
    Ensure the "Address ID" property is provided and correctly references an existing address in onOffice.

  • Error: Authentication failed
    Verify that the API key credential is valid and has sufficient permissions to read address data.

  • Error: Requested fields not found
    Confirm that the selected fields are valid and available for the address resource in onOffice.

  • Network or timeout errors
    Check network connectivity and API availability. Retry or increase timeout settings if necessary.

If the node is set to continue on failure, errors will be included in the output JSON under an error key instead of stopping execution.

Links and References

Discussion