/ConnectWise-Manage-Powershell

This is a PowerShell wrapper for the ConnectWise Manage REST API.

Primary LanguagePowerShell

ConnectWise Manage PowerShell REST API Wrapper

This is a PowerShell wrapper for the ConnectWise Manage REST API.

https://developer.connectwise.com/Products/Manage/REST

Getting Started

The simplest way to get started is to connect with your Manage username and password.

Please refer to the documentation for recommended authentication methods.

LogIn

The following example script will use the same information you use to log into Manage.

# This is the URL to your manage server.
$Server = 'server.example.com'

# This is the company entered at login
$Company = 'My Company ID'

# Create a credential object
$Credentials = Get-Credential

# Load the module into memory
iwr 'https://raw.githubusercontent.com/LabtechConsulting/ConnectWise-Manage-Powershell/master/CWManage.psm1' | iex

# Connect to Manage server
Connect-CWM -Server $Server -Company $Company -Credentials $Credentials

# Now that you are connected you can issue any of the avaliable commands
(Get-Module CWManage).ExportedCommands.Keys

# In the following example we are using a condition to find all contacts with the first name 'chris'.
$Chrises = Get-CWMContact -condition 'firstName="chris"' -all

# To clear your connection information from memory you can terminate the session or issue the disconnect command.
Disconnect-CWM

See below for a list of available commands.

Functions

Connect-CWM

ConvertFrom-CWMColumnRow

ConvertFrom-CWMTime

ConvertTo-CWMTime

Disconnect-CWM

Get-CWMAgreement

Get-CWMAgreementAddition

Get-CWMAuditTrail

Get-CWMBoardStatus

Get-CWMBoardStatusNotification

Get-CWMChargeCode

Get-CWMCompany

Get-CWMCompanyConfiguration

Get-CWMCompanyNotes

Get-CWMCompanyNoteTypes

Get-CWMCompanyStatus

Get-CWMCompanyTeam

Get-CWMCompanyTeamRole

Get-CWMCompanyType

Get-CWMCompanyTypeAssociation

Get-CWMContact

Get-CWMDocument

Get-CWMManufacturer

Get-CWMMarketingGroup

Get-CWMMarketingGroupCompany

Get-CWMMembers

Get-CWMProduct

Get-CWMProductCatalog

Get-CWMProductComponent

Get-CWMProductSubCategory

Get-CWMProductType

Get-CWMProject

Get-CWMProjectPhase

Get-CWMProjectSecurityRole

Get-CWMProjectTeamMember

Get-CWMReport

Get-CWMReportColumn

Get-CWMSalesActivity

Get-CWMScheduleEntry

Get-CWMServiceBoard

Get-CWMSystemInfo

Get-CWMTicket

Get-CWMTicketConfiguration

Get-CWMTicketNote

Get-CWMTimeEntry

Get-CWMTimeSheet

Invoke-CWMAllResult

Invoke-CWMDeleteMaster

Invoke-CWMGetMaster

Invoke-CWMNewMaster

Invoke-CWMPatchMaster

Invoke-CWMSearchMaster

Invoke-CWMWebRequest

New-CWMAgreementAddition

New-CWMCompanyTeam

New-CWMCompanyTypeAssociation

New-CWMContact

New-CWMProductCatalog

New-CWMProjectTeamMember

New-CWMScheduleEntry

New-CWMTicket

New-CWMTimeEntry

Remove-CWMCompanyConfiguration

Remove-CWMCompanyTypeAssociation

Remove-CWMMarketingGroupCompany

Remove-CWMScheduleEntry

Remove-CWMTicket

Submit-CWMTimeSheet

Update-CWMAgreementAddition

Update-CWMCompany

Update-CWMCompanyTypeAssociation

Update-CWMProductCatalog

Update-CWMProjectPhase

Update-CWMTicket