ConnectWise Manage icon

ConnectWise Manage

Consume ConnectWise Manage API

Overview

The node integrates with the ConnectWise Manage API to retrieve multiple contact records ("Get Many" operation on the "Contact" resource). It fetches a list of contacts from the ConnectWise system, supporting pagination, ordering, and limiting the number of results returned.

This node is useful in scenarios where you need to synchronize or analyze contact data stored in ConnectWise Manage, such as exporting contacts for marketing campaigns, generating reports, or integrating contact information into other systems.

Example use cases:

  • Retrieve all contacts to update a CRM system.
  • Fetch a specific page of contacts ordered by last name.
  • Limit the number of contacts retrieved for batch processing.

Properties

Name Meaning
Return All Whether to return all matching contacts or limit the number of results.
Limit Maximum number of contacts to return (used if "Return All" is false).
Page Number The page number of results to retrieve (starts at 1).
Page Size Number of contacts to return per page (max 1000).
Order By Field to order results by, e.g., "id", "lastName desc".

Note: The "Order By" property controls sorting of the results by any valid field supported by the API.

Output

The output consists of an array of JSON objects, each representing a contact record retrieved from ConnectWise Manage. Each item contains the full contact data as returned by the API, including fields like contact ID, first name, last name, company, and other contact details.

The node does not output binary data for this operation.

Example output item structure (simplified):

{
  "contactId": 123,
  "firstName": "John",
  "lastName": "Doe",
  "company": {
    "companyId": 456,
    "name": "Example Corp"
  },
  ...
}

Dependencies

  • Requires a configured API authentication credential for ConnectWise Manage.
  • Needs the ConnectWise Manage site URL and API credentials set up in n8n.
  • Uses the ConnectWise Manage REST API v3.0 endpoints.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Requesting pages beyond available data returns empty results.
    • Using unsupported fields in "Order By" may result in API errors.
    • Exceeding maximum page size (1000) will be rejected by the API.
  • Error messages:

    • "Operation 'getAll' is not supported": Indicates the operation is not recognized; verify correct operation name.
    • "Resource 'contact' is not supported": The resource name might be misspelled or unsupported.
    • API request failures often include error details logged in the console; check those for specifics.
    • "Phone Number is required for getByPhoneNumber operation.": If using phone number search, ensure the phone number parameter is provided.
  • Resolution tips:

    • Double-check API credentials and permissions.
    • Use valid field names for ordering and filtering.
    • Adjust pagination parameters within allowed ranges.
    • Enable "Return All" carefully to avoid large data loads.

Links and References

Discussion