ConnectWise Manage

Overview

The node integrates with the ConnectWise Manage API, specifically enabling operations on various resources such as companies, tickets, contacts, and more. For the Company resource with the Search operation, it allows users to perform filtered searches for companies based on a search query string. This is useful in scenarios where you want to find companies matching certain criteria within your ConnectWise Manage system, for example, searching for companies by name or other attributes.

Practical examples include:

• Searching for all companies containing "Tech" in their name.
• Filtering companies based on custom conditions or keywords.
• Ordering the search results by specific fields like company ID.

Properties

Note: The property "Order By" appears twice in the provided definitions but serves the same purpose — specifying the ordering of the returned results.

Output

The output consists of JSON objects representing the companies that match the search query. Each item corresponds to one company record retrieved from the ConnectWise Manage API.

• The json field contains the company data as returned by the API.
• There is no binary data output for this operation.

If multiple companies match the search criteria, the node outputs an array of items, each with its own JSON object.

Dependencies

• Requires an API key credential for authenticating with the ConnectWise Manage API.
• The node uses the base URL configured in the credentials to make REST API calls.
• No additional external dependencies are needed beyond the ConnectWise Manage API access.

Troubleshooting

• Common issues:

  • Missing or invalid API credentials will cause authentication failures.
  • Incorrect or malformed search queries may result in empty results or API errors.
  • Using unsupported fields in the "Order By" property might lead to unexpected ordering or errors.

• Error messages:

  • "Operation 'search' is not supported for resource 'company'": Indicates a misconfiguration or typo in the operation or resource selection.
  • API request failures will throw errors with messages from the ConnectWise Manage API; check the error details for rate limits, permission issues, or invalid parameters.
  • If the node returns an empty array, verify that the search query matches existing company records.

To resolve errors:

• Ensure the API credentials are correctly set up and have sufficient permissions.
• Validate the search query syntax according to ConnectWise Manage API documentation.
• Use valid field names for ordering.

Links and References

• ConnectWise Manage API Documentation
• ConnectWise Manage Company Resource Reference (for detailed fields and query options)