onOffice

Interact with onOffice API

Actions10

Overview

This node interacts with the onOffice API to retrieve multiple address records based on specified criteria. It is designed to fetch a list of addresses, optionally filtered and limited by various parameters such as email, city, postal code, status, newsletter subscription, and creation date range.

Common scenarios where this node is beneficial include:

  • Exporting customer or contact address data for marketing or CRM purposes.
  • Synchronizing address data between onOffice and other systems.
  • Filtering addresses to target specific groups, e.g., active customers in a certain city.
  • Retrieving all addresses or a subset based on limits for reporting or analysis.

For example, you could use this node to get all active addresses subscribed to the newsletter created after a certain date, including only their ID, first name, last name, and email fields.

Properties

Name Meaning
Fields Select which fields to include in the response. Options include: ID, Customer Number, First Name, Last Name, Company Name, Email, Phone, Mobile, Street, Postal Code, City, Country, Birthday, Created Date, Modified Date, Status. Default is ID, First Name, Last Name, Email.
Return All Boolean flag to return all matching results or limit the number of results returned.
Limit Maximum number of results to return if "Return All" is false. Minimum value is 1. Default is 50.
Filters Collection of filters to narrow down the results:
- Email (string)
- City (string)
- Postal Code (string)
- Status (Active or Inactive)
- Newsletter subscription (boolean)
- Created After (date/time)
- Created Before (date/time)

Output

The output is an array of JSON objects representing address records retrieved from the onOffice API. Each object contains the fields requested via the "Fields" property, such as ID, first name, last name, email, etc.

No binary data output is produced by this operation.

Example output structure (simplified):

[
  {
    "Id": "12345",
    "Vorname": "John",
    "Name": "Doe",
    "Email": "john.doe@example.com",
    "Strasse": "Main Street 1",
    "Plz": "12345",
    "Ort": "Sample City",
    "Land": "DEU",
    "Status": 1,
    "Geburtstag": "1980-01-01T00:00:00Z"
  },
  ...
]

Dependencies

  • Requires an API key credential for authenticating with the onOffice API.
  • The node makes HTTP POST requests to the /api.php endpoint of the onOffice API.
  • No additional external dependencies are required beyond the configured API credentials.

Troubleshooting

  • Empty results: Ensure that the filter criteria are correct and that the selected fields exist for the addresses in your onOffice account.
  • API authentication errors: Verify that the API key credential is valid and has sufficient permissions.
  • Invalid filter values: Date filters must be valid ISO date strings; incorrect formats may cause errors or no results.
  • Limit vs Return All: If "Return All" is false but the limit is set too low, you might not see all expected results.
  • Error messages from API: These will be surfaced in the node's error output if "Continue On Fail" is enabled; otherwise, execution stops on error.

Links and References

Discussion