Skip to main content

How to set up a security role and API user for ConnectWise integrations

This article explains how to create a dedicated security role and API member in ConnectWise Manage to connect it with Lexful.

Written by Jeremiah Hendrickson

Setting Up ConnectWise Manage API Credentials for Lexful


TL;DR: Follow these steps to generate the public and private API keys needed to integrate ConnectWise Manage with Lexful. You'll create a security role, an API member, and then generate the keys.


Overview

The integration requires three things in ConnectWise Manage: a security role with the correct permissions, an API member assigned to that role, and a set of API keys tied to that member.


Step 1: Create a Security Role

  • Open Security Roles — In ConnectWise Manage, go to System > Security Roles and click the plus icon (+).

  • Name the role — Enter a name (e.g. Lexful API Integration) and click Save.

  • Expand the relevant sections — On the Security Modules screen, click the down arrows next to Companies to expand the section.

  • Set permissions — For each section, update permissions to match the tables below. Click the down arrows in each row to change values from "None" to "All" where specified.

Companies

Module

Add

Edit

Delete

Inquire

Company Maintenance

None

None

None

All

Configuration -
Display Passwords

None

None

None

All

Configurations

None

None

None

All

Contacts

None

None

None

All

System > My Company

None

None

None

All

System > Table Setup

None

None

None

All

  • Save — Click the Save and Close icon.


Step 2: Create an API Member

  • Navigate to API Members — Go to System > Members > API Members tab and click the plus icon (+) > New Member.

  • Complete the Profile section:

    • Member ID — Enter a username (e.g. Lexful). Maximum 15 characters.

    • Time Zone — Select the time zone for your internal company.

    • Member Name — Enter a first and last name for the member.

  • Complete the System section:

    • Role ID — Select the security role you created in Step 1 (e.g. Lexful API Integration).

    • Location — Select the default location for the company. New records created by this member will default to this location.

    • Level — Select the member's access level. The member can search for companies at this level and below.

⚠️ Warning: Select the highest available access level (e.g. Level 1). A lower level may prevent some companies from syncing to Lexful.

  • Business Unit — Select the member's business unit.

  • Name — After selecting a Level, select the specific name associated with that structure level.

  • Default Territory — Select the member's default territory.

📝 Note: For help setting up Locations, Business Units, and Territories, refer to ConnectWise's documentation.

Save — Click the Save icon in the top menu bar.


Step 3: Generate API Keys

  • Open the API Keys tab — Click the API Keys tab on the member's profile, then click the plus icon (+).

  • Name the key — Enter a description (e.g. Lexful) and click Save.

  • Once saved, ConnectWise Manage will display the public and private keys.

⚠️ Warning: Copy and store the private key in a secure location immediately. It will not be visible again after you close this window.


Did this answer your question?