Overview

This node reads address records from the onOffice system. It allows users to specify an Address ID to retrieve a specific record or select multiple parameters to filter and customize the data output. The node supports additional options such as formatted output, limiting the number of results, offsetting the start of the list, and sorting the results by a specified field in ascending or descending order. This is useful for scenarios where users need to fetch detailed address information for contacts, companies, or locations stored in onOffice, such as for CRM integrations, mailing lists, or contact management.

Use Case Examples

1. Fetch a specific address record by its ID to display detailed contact information in a dashboard.
2. Retrieve a list of addresses filtered by parameters like city, postal code, or company name for targeted marketing campaigns.
3. Get a sorted and paginated list of addresses to synchronize with another database or system.

Properties

Output

JSON

• addressId - The unique identifier of the retrieved address record.
• parameters - The selected fields and their values from the address record.
• formattedOutput - Formatted version of the address data if enabled.
• totalCount - Total number of address records matching the query if multiple records are retrieved.

Dependencies

• An API key credential for onOffice to authenticate requests.

Troubleshooting

• Ensure the Address ID is valid and exists in the onOffice system to avoid errors or empty results.
• Check that the API key credential is correctly configured and has sufficient permissions to read address data.
• If no records are returned, verify the filter parameters and pagination settings are correct and not excluding all data.
• Errors related to sorting or limits may occur if invalid values are provided; ensure 'Limit' is between 0 and 500 and 'Order' is either ASC or DESC.