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, specifically enabling operations on various resources including Agreements. For the Agreement - Search operation, it allows users to query and retrieve agreement records from ConnectWise Manage based on specified conditions.
This is useful in scenarios where you want to filter agreements dynamically, for example:
- Finding all agreements with a name starting with "Test".
- Retrieving agreements of a specific type such as "Standard".
- Sorting agreements by a particular field like ID in descending order.
- Controlling the number of results returned or fetching all matching agreements.
Practical examples:
- A service desk workflow that needs to pull all active agreements related to a customer before creating a ticket.
- Reporting automation that extracts agreements meeting certain criteria for further processing or export.
Properties
| Name | Meaning |
|---|---|
| Conditions | Query conditions to filter agreements (e.g., name like 'Test%' or type='Standard'). Required. |
| Order By | Field to order results by, e.g., "ID desc" to sort by ID descending. |
| Return All | Boolean flag indicating whether to return all matching results or limit the output. |
| Limit | Maximum number of results to return if Return All is false. Minimum value is 1. |
Output
- The output is an array of JSON objects, each representing an agreement record retrieved from ConnectWise Manage.
- Each item contains the full data fields of an agreement as returned by the API.
- The structure corresponds directly to the ConnectWise Manage agreement resource schema.
- No binary data output is produced by this operation.
Dependencies
- Requires an API key credential configured in n8n for authenticating with the ConnectWise Manage API.
- The node makes HTTP requests to the ConnectWise Manage REST API endpoint, which must be accessible.
- Proper permissions on the API key are necessary to perform search queries on agreements.
Troubleshooting
- Invalid or missing conditions: The
Conditionsproperty is required; omitting it or providing invalid syntax will cause errors. - API authentication errors: Ensure the API key credential is correctly set up and has sufficient permissions.
- Unsupported operations: Using an operation other than those supported for the Agreement resource will throw an error.
- Rate limiting or network issues: API request failures may occur due to network problems or rate limits imposed by ConnectWise Manage.
- Limit vs Return All confusion: Setting
Return Allto false but not specifying a reasonableLimitmight result in fewer results than expected.
Common error messages:
"Operation 'search' is not supported for resource 'agreement'"— indicates a misconfiguration or unsupported operation."API request failed"— generic failure, check credentials and network connectivity.- Errors related to malformed query conditions — verify the syntax matches ConnectWise Manage query language.