ConnectWise Manage icon

ConnectWise Manage

Consume ConnectWise Manage API

Actions102

Overview

The node integrates with the ConnectWise Manage API to retrieve multiple Agreement records. It supports fetching paginated lists of agreements with options to control sorting, pagination, and result limits. This is useful for scenarios where you need to synchronize or analyze financial agreement data from ConnectWise Manage within an automation workflow.

Practical examples include:

  • Retrieving all active agreements for reporting or auditing.
  • Fetching a specific page of agreements sorted by ID or date.
  • Exporting agreement data to another system or database.

Properties

Name Meaning
Order By Field to order results by, e.g., "ID desc" to sort by ID in descending order.
Page Number The page number to retrieve, starting at 1.
Page Size Number of results to return per page (minimum 1, maximum 1000).
Return All Whether to return all results across pages or only up to a given limit.
Limit Maximum number of results to return when not returning all (minimum 1).

Output

The output is an array of JSON objects representing Agreement records retrieved from ConnectWise Manage. Each item corresponds to one agreement and contains its properties as returned by the API.

If the node is configured to return all results, it will paginate internally and aggregate all pages before outputting.

No binary data output is produced for this operation.

Dependencies

  • Requires an API key credential for authenticating with the ConnectWise Manage API.
  • The node makes HTTP requests to the ConnectWise Manage REST API endpoint specified in the credentials.
  • Proper API permissions are needed to access the finance/agreements resource.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Requesting a page number beyond available pages may return empty results.
    • Using unsupported orderBy fields may cause API errors.
    • Exceeding the maximum page size (1000) will be rejected.

  • Error messages:

    • "Operation 'getMany' is not supported": Occurs if the operation name is incorrect or not implemented.
    • "Resource 'agreement' is not supported": Happens if the resource parameter is invalid.
    • API request failures will throw errors with messages from the ConnectWise API response.

  • Resolutions:

    • Verify API credentials and permissions.
    • Use valid property values according to the documentation.
    • Handle pagination carefully when using returnAll to avoid large data loads.

Links and References

Discussion