Overview
This node integrates with the ConnectWise API to retrieve information about companies. Specifically, the "Get" operation under the "Company" resource fetches a list of companies from ConnectWise. This is useful for scenarios where you need to synchronize company data, generate reports, or automate workflows based on company information stored in ConnectWise.
For example, you might use this node to:
- Retrieve all companies that meet certain criteria (e.g., companies in a specific region).
- Fetch only selected fields of company data to optimize performance.
- Paginate through large sets of company records.
Properties
| Name | Meaning |
|---|---|
| Conditions | A string to filter which companies to retrieve, using ConnectWise query syntax. |
| Fields | A comma-separated string specifying which company fields to return in the response. |
| Page ID | The page number of results to retrieve (for pagination). |
| Page Size | The number of company records to return per page (default is 1000). |
Output
The node outputs JSON data representing the list of companies retrieved from ConnectWise. Each item in the output corresponds to a company object containing the requested fields. The structure depends on the fields specified but generally includes company details such as name, contact info, and other metadata.
No binary data is output by this node.
Dependencies
- Requires an API key credential for authenticating with the ConnectWise API.
- The base URL for API requests is dynamically constructed using the datacentre value from credentials.
- The node sends HTTP GET requests to the
/company/companiesendpoint of the ConnectWise API.
Troubleshooting
- Empty results: If no companies are returned, verify the
Conditionsproperty for correct filtering syntax. - Authentication errors: Ensure the API key credential is correctly configured and has sufficient permissions.
- Pagination issues: If retrieving large datasets, adjust
Page IDandPage Sizeappropriately to navigate through pages. - Invalid fields: Specifying non-existent fields in
Fieldsmay cause errors or empty values; check field names against ConnectWise API documentation.