Actions102
- Activity Actions
- Agreement Actions
- Company Actions
- Configuration Actions
- Contact Actions
- Document Actions
- Expense Actions
- Invoice Actions
- Member Actions
- Opportunity Actions
- Product Catalog Actions
- Project Actions
- Purchase Order Actions
- Schedule Actions
- Service Ticket Actions
- Time Actions
Overview
The node integrates with the ConnectWise Manage API to perform operations on various resources, including Contacts. Specifically, for the Contact - Search operation, it allows users to search for contacts in ConnectWise Manage using a flexible query language. Users can specify conditions such as exact matches (firstName="John") or pattern matching (lastName like "Smith%") to filter contacts.
This node is beneficial when you need to dynamically find contacts based on specific criteria within your workflows, such as retrieving customer details before creating tickets, updating records, or syncing contact data with other systems.
Practical example:
You want to find all contacts whose last name starts with "Smith" and order the results by their ID in descending order. You provide the search query lastName like "Smith%" and set the order by field to "id desc". The node returns matching contacts accordingly.
Properties
| Name | Meaning |
|---|---|
| Search Query | A required string defining the search condition to filter contacts. Supports expressions like firstName="John" or lastName like "Smith%". |
| Return All | Boolean flag indicating whether to return all matching contacts or limit the number of results. |
| Limit | Number specifying the maximum number of contacts to return if "Return All" is false. Minimum value is 1. |
| Order By | String specifying the field to order the results by, e.g., "id", "id desc". |
Output
- The output is an array of JSON objects, each representing a contact that matches the search criteria.
- Each JSON object contains the contact's properties as returned by the ConnectWise Manage API (e.g., contactId, firstName, lastName, company, etc.).
- If multiple contacts match, the node outputs one item per contact.
- The node does not output binary data for this operation.
Dependencies
- Requires an active connection to the ConnectWise Manage API.
- Needs an API authentication credential configured in n8n to authorize requests.
- The node uses the ConnectWise Manage REST API v4_6_release endpoints.
- No additional external dependencies are required beyond the API access.
Troubleshooting
Common issues:
- Invalid or malformed search queries may cause the API to reject the request or return no results.
- Missing or incorrect API credentials will result in authentication errors.
- Exceeding API rate limits could cause temporary failures.
- Specifying an unsupported "Order By" field might lead to unexpected ordering or errors.
Error messages:
"Operation 'search' is not supported for resource 'contact'": Indicates a misconfiguration or typo in the operation or resource selection."API request failed": Generic error indicating the API call did not succeed; check credentials and network connectivity."Search query to filter contacts is required": The required search query property was not provided.- Errors related to pagination or limits usually mean the "Limit" or "Return All" settings need adjustment.
Resolution tips:
- Verify the search query syntax matches ConnectWise Manage API expectations.
- Ensure API credentials are valid and have sufficient permissions.
- Use smaller limits or enable "Return All" carefully to avoid large data loads.
- Check the ConnectWise Manage API documentation for supported fields and query formats.