Actions58
- Address Actions
- Agentslog Actions
- Appointment Actions
- E-Mail Actions
- Estate Actions
- File Actions
- Relation Actions
- Search Criterion Actions
- Setting Actions
- Task Actions
- Template Actions
Address → Search
AI-generatedOverview
This node performs a search operation on address data within the onOffice system. It allows users to search for addresses based on a search term that can match fields such as firstname, surname, company, email, or customer number. The node supports additional options to customize the search, including case sensitivity, inclusion of contact data, limiting the number of results, specifying which fields to search, and sorting the results by various address-related fields.
Use Case Examples
- A real estate agent wants to find all contacts with the surname 'Smith' in their address book, including all associated email addresses and phone numbers, sorted by customer number in descending order.
- A user needs to search for all addresses related to a specific company name, limiting the results to 10 entries and ensuring the search is case-sensitive.
Properties
| Name | Meaning |
|---|---|
| Search Input | The search term to look for in address fields such as firstname, surname, company, email, or customer number. |
| Case Sensitive | Whether the search should be case-sensitive. |
| Include Contact Data | Whether to search all email addresses and telephone numbers, not just the default ones. |
| List Limit | Maximum number of records to return. |
| Search Parameters | Comma-separated list of specific fields to include in the search (e.g., First Name, Last Name). |
| Sort By | Field to sort the search results by, such as Company, Contact Category, Customer Number, Email, First Name, or Last Name. |
| Sort Order | Sort order for the results, either ascending or descending. |
Output
JSON
results- Array of address records matching the search criteria, including fields such as firstname, surname, company, email, and customer number.
Dependencies
- Requires an API key credential for onOffice API authentication to perform the search.
Troubleshooting
- If no results are returned, verify that the search input is correct and that the specified search parameters include the fields you want to search.
- If the node returns an authentication error, check that the onOffice API credentials are correctly configured and valid.
- If the search results are not sorted as expected, ensure the 'Sort By' and 'Sort Order' fields are set correctly.