ConnectWise Manage icon

ConnectWise Manage

Consume ConnectWise Manage API

Overview

The node integrates with the ConnectWise Manage API to perform operations on various resources, including members. Specifically, the Member - Search operation allows users to search for members in the ConnectWise system using a custom search query. This is useful when you want to filter and retrieve member records based on specific criteria, such as name, email, role, or other attributes supported by the API's query language.

Common scenarios include:

  • Finding members that match certain conditions (e.g., all active members in a department).
  • Retrieving member details dynamically based on user input or workflow data.
  • Automating member lookups to enrich data or trigger further actions in workflows.

Example: Searching for members whose name contains "Smith" and ordering results by their ID descending.

Properties

Name Meaning
Search Query The search query string used to filter members. This is required and defines the filter conditions.
Order By Field to order the search results by. For example, "id", "name desc", etc. Defaults to "id".

Output

The output of the search operation is an array of JSON objects, each representing a member record returned by the ConnectWise Manage API matching the search criteria.

Each item in the output has the following structure:

{
  "json": {
    // Member fields as returned by the API, e.g.:
    "memberId": 123,
    "identifier": "jsmith",
    "name": "John Smith",
    "email": "jsmith@example.com",
    // ... other member properties ...
  },
  "pairedItem": {
    "item": <index_of_input_item>
  }
}

No binary data is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the ConnectWise Manage API.
  • The node expects the ConnectWise Manage site URL and authentication credentials to be configured in n8n.
  • The API endpoint used for members is /v4_6_release/apis/3.0/system/members.

Troubleshooting

  • Error: Operation 'search' is not supported for resource 'member'
    This indicates a misconfiguration or typo in the operation or resource name. Ensure "member" is selected as the resource and "search" as the operation.

  • API request failed / ConnectWise Error Response Body:
    Indicates an issue with the API call, possibly due to invalid credentials, incorrect query syntax, or network issues. Verify your API credentials and the correctness of the search query string.

  • Missing required parameter 'searchQuery'
    The search query property is mandatory. Make sure to provide a valid query string.

  • Empty results returned
    This means no members matched the search query. Try broadening the search conditions or verify the query syntax.

Links and References

Discussion