ConnectWise Manage Tools
cw_ · 785 tools · Free 481 · Pro 304
Basic auth (companyId+publicKey:privateKey) + clientId header; page size capped at 200; raw JSON passthrough.
Service Tickets
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_count_tickets |
Free | Read-only | [ConnectWise] Get a count of service tickets matching optional conditions. Returns the total number of matching tickets without fetching ticket data. Useful for dashboards, reporting, and checking result set size before paginating with cw_list_tickets. |
cw_create_ticket |
Pro | Write | [ConnectWise] Create a new service ticket. Requires at minimum a summary and board reference. Call cw_discover_boards first to find valid board IDs. Returns the created ticket with its assigned ID. This creates data visible to helpdesk staff and end users. |
cw_delete_ticket |
Pro | Destructive | [ConnectWise] Permanently delete a service ticket by ID. This cannot be undone. Verify the ticket with cw_get_ticket before deleting. Requires a valid ticket ID — use cw_list_tickets or cw_search_tickets to find IDs. |
cw_get_ticket |
Free | Read-only | [ConnectWise] Retrieve a single service ticket by ID. Returns ticket header fields including summary, status, priority, board, company, contact, assigned resources, SLA timing (dateResolved, resolvedBy, resolutionHours, resolutionGoalUTC), and custom fields. NOTE: The ConnectWise API does NOT return the body text of the Description, Internal Analysis, or Resolution tabs in this response — those live in ticket notes flagged with detailDescriptionFlag, internalAnalysisFlag, or resolutionFlag. Use cw_get_ticket_description, cw_get_ticket_internal_analysis, and cw_get_ticket_resolution to fetch each, or cw_list_ticket_notes for everything. Requires a valid ticket ID — use cw_list_tickets or cw_search_tickets to find IDs. |
cw_list_company_tickets |
Free | Read-only | [ConnectWise] List open tickets for a specific company. A convenience tool that filters tickets to a single company. Useful for reviewing a client's current issues. |
cw_list_high_priority_tickets |
Free | Read-only | [ConnectWise] List open tickets with critical or high priority. Useful for urgent triage -- returns only tickets where priority is 'Priority 1 - Critical' or 'Priority 2 - High' and closedFlag=false, ordered by newest first. |
cw_list_member_tickets |
Free | Read-only | [ConnectWise] List open tickets assigned to a specific member. A convenience tool that filters tickets to a single assignee. Useful for viewing a technician's current workload. |
cw_list_open_tickets |
Free | Read-only | [ConnectWise] List all open (non-closed) service tickets. A convenience filter that returns only tickets with closedFlag=false. Useful for quick helpdesk queue views. |
cw_list_recently_updated_tickets |
Free | Read-only | [ConnectWise] List tickets ordered by last update time, newest updates first. Useful for monitoring recent activity across the helpdesk without filtering by status or priority. |
cw_list_tickets |
Free | Read-only | [ConnectWise] List service tickets with optional filtering, sorting, and field selection. Returns paginated ticket summaries including ID, summary, status, priority, board, and company. Use this to browse tickets or narrow results before fetching full details with cw_get_ticket. Call cw_discover_boards and cw_discover_statuses first to learn valid filter values. |
cw_list_unassigned_tickets |
Free | Read-only | [ConnectWise] List open tickets that have no assigned resources. Useful for triage queues -- shows tickets waiting to be dispatched. Returns tickets with closedFlag=false and no owner assigned, ordered by newest first. |
cw_search_tickets |
Free | Read-only | [ConnectWise] Search service tickets by keyword across summary and description fields. Returns matching tickets ranked by relevance. Use this when looking for tickets by keyword, error message, or description rather than structured filtering with cw_list_tickets. |
cw_update_ticket |
Pro | Write | [ConnectWise] Update an existing service ticket using JSON Patch operations. Requires a valid ticket ID — use cw_list_tickets or cw_search_tickets to find IDs. Returns the updated ticket. |
cw_count_tickets parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | Optional ConnectWise conditions filter. ConnectWise filter grammar (NOT SQL or OData). Form: field op value, joined by 'and'/'or', grouped with ( ). Nested fields use '/': status/name, company/id, company/identifier, owner/id. Operators: =, !=, <, <=, >, >=, 'contains' (substring), 'like' (with % wildcard), 'in (...)'. Quote string values with single quotes, e.g. status/name='Open' (double quotes also work but must be escaped inside JSON). Dates go in square brackets: lastUpdated>[2026-01-01T00:00:00Z]. Booleans and null are bare keywords: closedFlag=false, owner/id=null. Examples: status/name='Open' and closedFlag=false ; company/id=123 and priority/name!='Low' ; summary contains 'vpn'. Avoid SQL: no leading WHERE, no '==' (use '='), do not leave string values unquoted. |
cw_create_ticket parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Ticket fields as JSON. Required: {"summary": "...", "board": {"id": N}}. Optional: status, priority, company, contact, type, subType, item, team, owner, site, serviceLocation. |
cw_delete_ticket parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise ticket ID to delete. Verify with cw_get_ticket before deleting. |
cw_get_ticket parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise ticket ID. |
cw_list_company_tickets parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The numeric ConnectWise company ID. | |
includeClosed |
boolean | no | false | Include closed tickets (default false, shows only open). |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_high_priority_tickets parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_member_tickets parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
memberIdentifier |
string | yes | The ConnectWise member identifier (e.g., 'jsmith'). | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_open_tickets parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_recently_updated_tickets parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_tickets parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | Optional ConnectWise conditions filter. ConnectWise filter grammar (NOT SQL or OData). Form: field op value, joined by 'and'/'or', grouped with ( ). Nested fields use '/': status/name, company/id, company/identifier, owner/id. Operators: =, !=, <, <=, >, >=, 'contains' (substring), 'like' (with % wildcard), 'in (...)'. Quote string values with single quotes, e.g. status/name='Open' (double quotes also work but must be escaped inside JSON). Dates go in square brackets: lastUpdated>[2026-01-01T00:00:00Z]. Booleans and null are bare keywords: closedFlag=false, owner/id=null. Examples: status/name='Open' and closedFlag=false ; company/id=123 and priority/name!='Low' ; summary contains 'vpn'. Avoid SQL: no leading WHERE, no '==' (use '='), do not leave string values unquoted. |
orderBy |
string | no | null | Sort order. Examples: "id desc", "dateEntered asc". Use field names from the ticket object. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_unassigned_tickets parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_search_tickets parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
search |
string | yes | Search term to match against ticket summary and description. |
cw_update_ticket parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise ticket ID to update. | |
patchJson |
string | yes | JSON array of patch operations. Example: [{"op": "replace", "path": "status", "value": {"id": 5}}, {"op": "replace", "path": "priority", "value": {"id": 3}}] |
Ticket Notes & Tasks
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_create_ticket_note |
Pro | Write | [ConnectWise] Add a note to a service ticket. Use internalAnalysisFlag for internal-only notes or externalFlag for customer-visible notes. Requires a valid ticket ID — use cw_list_tickets to find IDs. |
cw_create_ticket_task |
Pro | Write | [ConnectWise] Add a task to a service ticket. Tasks represent individual work items within a ticket. Requires a valid ticket ID — use cw_list_tickets to find IDs. |
cw_delete_ticket_note |
Pro | Destructive | [ConnectWise] Permanently delete a ticket note. This cannot be undone. Verify the note with cw_get_ticket_note before deleting. |
cw_delete_ticket_task |
Pro | Destructive | [ConnectWise] Permanently delete a ticket task. This cannot be undone. Verify the task with cw_get_ticket_task before deleting. |
cw_get_ticket_description |
Free | Read-only | [ConnectWise] Retrieve the Description-tab notes for a service ticket. ConnectWise stores description body text as ticket notes with detailDescriptionFlag=true (NOT as a field on the ticket itself). Returns notes ordered oldest-first to match the CW UI. Use this when cw_get_ticket doesn't show the description text. Requires a valid ticket ID. |
cw_get_ticket_internal_analysis |
Free | Read-only | [ConnectWise] Retrieve the Internal Analysis-tab notes for a service ticket. ConnectWise stores internal analysis body text as ticket notes with internalAnalysisFlag=true (NOT as a field on the ticket itself). Returns notes ordered oldest-first to match the CW UI. Use this when cw_get_ticket doesn't show the internal analysis text. Requires a valid ticket ID. |
cw_get_ticket_note |
Free | Read-only | [ConnectWise] Retrieve a single ticket note by ticket ID and note ID. Returns the full note including text, internal/external flags, contact info, and timestamps. Use cw_list_ticket_notes to find valid note IDs. |
cw_get_ticket_resolution |
Free | Read-only | [ConnectWise] Retrieve the Resolution-tab notes for a service ticket. ConnectWise stores resolution body text as ticket notes with resolutionFlag=true (NOT as a field on the ticket itself — the Ticket schema's initialResolution is POST-only and never returned on read). Returns notes ordered oldest-first to match the CW UI. Use this when cw_get_ticket doesn't show the resolution text. Requires a valid ticket ID. |
cw_get_ticket_task |
Free | Read-only | [ConnectWise] Retrieve a single ticket task by ticket ID and task ID. Returns full task details including notes, priority, schedule, and completion status. Use cw_list_ticket_tasks to find valid task IDs. |
cw_list_ticket_notes |
Free | Read-only | [ConnectWise] List notes for a specific service ticket. Returns paginated note summaries including ID, text, internal/external flags (detailDescriptionFlag, internalAnalysisFlag, resolutionFlag, issueFlag), member, contact, and timestamps. The Description, Internal Analysis, and Resolution tabs in the ConnectWise UI are stored as notes with the corresponding flag set — filter with conditions like "detailDescriptionFlag=true", "internalAnalysisFlag=true", or "resolutionFlag=true" to retrieve only those, or use the cw_get_ticket_description / cw_get_ticket_internal_analysis / cw_get_ticket_resolution convenience tools. Requires a valid ticket ID — use cw_list_tickets or cw_search_tickets to find IDs. |
cw_list_ticket_tasks |
Free | Read-only | [ConnectWise] List tasks for a specific service ticket. Returns paginated task summaries including ID, notes, priority, and completion status. Tasks represent work items within a ticket. Requires a valid ticket ID. |
cw_update_ticket_note |
Pro | Write | [ConnectWise] Update an existing ticket note using JSON Patch operations. Requires valid ticket ID and note ID — use cw_list_ticket_notes to find note IDs. |
cw_update_ticket_task |
Pro | Write | [ConnectWise] Update an existing ticket task using JSON Patch operations. Requires valid ticket ID and task ID — use cw_list_ticket_tasks to find task IDs. |
cw_create_ticket_note parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Note fields as JSON. Example: {"text": "Note text here", "internalAnalysisFlag": true, "externalFlag": false}. Set detailDescriptionFlag, internalAnalysisFlag, or externalFlag to control visibility. | |
ticketId |
integer | yes | The numeric ConnectWise ticket ID to add the note to. |
cw_create_ticket_task parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Task fields as JSON. Example: {"notes": "Task description", "priority": 1, "closedFlag": false}. | |
ticketId |
integer | yes | The numeric ConnectWise ticket ID to add the task to. |
cw_delete_ticket_note parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
noteId |
integer | yes | The numeric note ID to delete. Verify with cw_get_ticket_note before deleting. | |
ticketId |
integer | yes | The numeric ConnectWise ticket ID. |
cw_delete_ticket_task parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
taskId |
integer | yes | The numeric task ID to delete. Verify with cw_get_ticket_task before deleting. | |
ticketId |
integer | yes | The numeric ConnectWise ticket ID. |
cw_get_ticket_description parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). Most tickets have only a few description notes. |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
ticketId |
integer | yes | The numeric ConnectWise ticket ID. |
cw_get_ticket_internal_analysis parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
ticketId |
integer | yes | The numeric ConnectWise ticket ID. |
cw_get_ticket_note parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
noteId |
integer | yes | The numeric note ID. Use cw_list_ticket_notes to find valid IDs. | |
ticketId |
integer | yes | The numeric ConnectWise ticket ID. |
cw_get_ticket_resolution parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
ticketId |
integer | yes | The numeric ConnectWise ticket ID. |
cw_get_ticket_task parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
taskId |
integer | yes | The numeric task ID. Use cw_list_ticket_tasks to find valid IDs. | |
ticketId |
integer | yes | The numeric ConnectWise ticket ID. |
cw_list_ticket_notes parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "resolutionFlag=true", "detailDescriptionFlag=true", "internalAnalysisFlag=true", "issueFlag=true". Use 'and'/'or' for boolean logic. |
orderBy |
string | no | null | Sort order. Examples: "id asc" (oldest first, matches CW UI), "id desc". |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
ticketId |
integer | yes | The numeric ConnectWise ticket ID to list notes for. |
cw_list_ticket_tasks parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='New'", "company/id=123 and priority/name!='Low'". Use '/' for nested fields, 'and'/'or' for boolean logic. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
ticketId |
integer | yes | The numeric ConnectWise ticket ID to list tasks for. |
cw_update_ticket_note parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
noteId |
integer | yes | The numeric note ID to update. Use cw_list_ticket_notes to find valid IDs. | |
patchJson |
string | yes | JSON array of patch operations. Example: [{"op": "replace", "path": "text", "value": "Updated note text"}] | |
ticketId |
integer | yes | The numeric ConnectWise ticket ID. |
cw_update_ticket_task parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
patchJson |
string | yes | JSON array of patch operations. Example: [{"op": "replace", "path": "closedFlag", "value": true}] | |
taskId |
integer | yes | The numeric task ID to update. Use cw_list_ticket_tasks to find valid IDs. | |
ticketId |
integer | yes | The numeric ConnectWise ticket ID. |
Ticket Sub-Resources
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_add_ticket_config |
Pro | Write | [ConnectWise] Associate a configuration (asset) with a service ticket. Returns the created association. Requires valid ticket and configuration IDs -- use cw_list_tickets and cw_list_configurations to find IDs. |
cw_list_ticket_configs |
Free | Read-only | [ConnectWise] List all configurations (assets) associated with a service ticket. Returns configuration details including ID, name, type, and company. Requires a valid ticket ID -- use cw_list_tickets to find IDs. |
cw_list_ticket_documents |
Free | Read-only | [ConnectWise] List all documents attached to a service ticket. Returns document metadata including ID, title, file name, and upload date. Requires a valid ticket ID -- use cw_list_tickets to find IDs. |
cw_list_ticket_products |
Free | Read-only | [ConnectWise] List all products associated with a service ticket. Returns product details including ID, description, quantity, price, and billing status. Requires a valid ticket ID -- use cw_list_tickets to find IDs. |
cw_list_ticket_scheduleentries |
Free | Read-only | [ConnectWise] List all schedule entries for a service ticket. Returns schedule details including member, start/end times, and status. Requires a valid ticket ID -- use cw_list_tickets to find IDs. |
cw_list_ticket_timeentries |
Free | Read-only | [ConnectWise] List all time entries logged against a service ticket. Returns time entry details including member, hours, work type, and billing status. Requires a valid ticket ID -- use cw_list_tickets to find IDs. |
cw_remove_ticket_config |
Pro | Destructive | [ConnectWise] Remove a configuration (asset) association from a service ticket. This only removes the link, not the configuration itself. Requires valid ticket and configuration IDs. |
cw_add_ticket_config parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the configuration association. Example: {"id": 42}. The id refers to the configuration/asset ID. | |
ticketId |
integer | yes | The ConnectWise ticket ID to add the configuration to. |
cw_list_ticket_configs parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number for pagination (default 1). |
pageSize |
integer | no | 50 | Number of results per page (default 50, max 200). |
ticketId |
integer | yes | The ConnectWise ticket ID. |
cw_list_ticket_documents parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number for pagination (default 1). |
pageSize |
integer | no | 50 | Number of results per page (default 50, max 200). |
ticketId |
integer | yes | The ConnectWise ticket ID. |
cw_list_ticket_products parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number for pagination (default 1). |
pageSize |
integer | no | 50 | Number of results per page (default 50, max 200). |
ticketId |
integer | yes | The ConnectWise ticket ID. |
cw_list_ticket_scheduleentries parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number for pagination (default 1). |
pageSize |
integer | no | 50 | Number of results per page (default 50, max 200). |
ticketId |
integer | yes | The ConnectWise ticket ID. |
cw_list_ticket_timeentries parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number for pagination (default 1). |
pageSize |
integer | no | 50 | Number of results per page (default 50, max 200). |
ticketId |
integer | yes | The ConnectWise ticket ID. |
cw_remove_ticket_config parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
configId |
integer | yes | The configuration ID to remove from the ticket. | |
ticketId |
integer | yes | The ConnectWise ticket ID. |
Service Boards & Configuration
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_discover_board_teams |
Free | Read-only | [ConnectWise] List all teams configured for a specific service board. Returns team IDs and names. Teams control ticket routing and assignment. Call this to discover valid team values before creating or updating tickets. |
cw_discover_boards |
Free | Read-only | [ConnectWise] List all service boards. Returns board IDs, names, and configuration. Boards are the top-level organizer for tickets — call this first to discover valid board IDs before creating tickets with cw_create_ticket or filtering with cw_list_tickets. |
cw_discover_codes |
Free | Read-only | [ConnectWise] List all service codes. Returns code IDs, names, and descriptions. Service codes are used for categorization and billing. Call this to discover valid code values for ticket workflows. |
cw_discover_impacts |
Free | Read-only | [ConnectWise] List all service impact levels. Returns impact IDs and names. Impacts measure the breadth of an issue (e.g., single user vs. whole department). Used alongside severity for priority calculations and SLA assignment. |
cw_discover_items |
Free | Read-only | [ConnectWise] List all items for a specific service board. Returns item IDs and names. Items are the third level of ticket categorization after type and subtype. Call this to discover valid item values before creating tickets. |
cw_discover_priorities |
Free | Read-only | [ConnectWise] List all service priorities. Returns priority IDs, names, colors, and sort order. Priorities define urgency levels for tickets. Call this to discover valid priority values before creating or filtering tickets. |
cw_discover_service_locations |
Free | Read-only | [ConnectWise] List all service locations. Returns location IDs and names. Service locations define where work is performed (e.g., On-Site, Remote). Call this to discover valid location values for ticket creation. |
cw_discover_severities |
Free | Read-only | [ConnectWise] List all service severity levels. Returns severity IDs and names. Severities measure the depth of an issue (e.g., inconvenience vs. system down). Used alongside impact for priority calculations and SLA assignment. |
cw_discover_sla_priorities |
Free | Read-only | [ConnectWise] List all priority configurations for a specific SLA. Returns priority-level response and resolution targets, escalation rules, and calendar settings. Requires a valid SLA ID -- use cw_discover_slas to find IDs. |
cw_discover_slas |
Free | Read-only | [ConnectWise] List all Service Level Agreements (SLAs). Returns SLA IDs, names, and configuration. SLAs define response and resolution time targets for tickets. Call this to understand available SLA policies. |
cw_discover_sources |
Free | Read-only | [ConnectWise] List all service sources. Returns source IDs and names. Sources track how tickets originate (e.g., Email, Phone, Portal). Call this to discover valid source values for ticket creation and reporting. |
cw_discover_statuses |
Free | Read-only | [ConnectWise] List all statuses for a specific service board. Returns status IDs, names, and workflow configuration. Statuses define the lifecycle stages of tickets on a board. Call this to discover valid status values before creating or updating tickets. |
cw_discover_subtypes |
Free | Read-only | [ConnectWise] List all subtypes for a specific service board. Returns subtype IDs and names. SubTypes further categorize tickets within a type. Call this to discover valid subtype values before creating tickets. |
cw_discover_surveys |
Free | Read-only | [ConnectWise] List all service surveys. Returns survey IDs, names, and configuration. Surveys are used for customer satisfaction feedback on resolved tickets. |
cw_discover_types |
Free | Read-only | [ConnectWise] List all types for a specific service board. Returns type IDs and names. Types categorize tickets on a board (e.g., Incident, Problem, Request). Call this to discover valid type values before creating tickets. |
cw_get_board |
Free | Read-only | [ConnectWise] Retrieve a single service board by ID. Returns full board configuration including name, location, department, and dispatch settings. Use cw_discover_boards to find valid board IDs. |
cw_get_priority |
Free | Read-only | [ConnectWise] Retrieve a single priority by ID. Returns full priority details including name, color, sort order, and default flag. Use cw_discover_priorities to find valid priority IDs. |
cw_get_service_template |
Free | Read-only | [ConnectWise] Retrieve a single service template by ID. Returns full template details including name, board, summary, description, and all pre-configured ticket fields. Use cw_list_service_templates to find valid template IDs. |
cw_get_sla |
Free | Read-only | [ConnectWise] Retrieve a single SLA by ID. Returns full SLA details including name, response/resolution targets, and priority-based escalation rules. Use cw_discover_slas to find valid SLA IDs. |
cw_list_service_templates |
Free | Read-only | [ConnectWise] List all service templates. Returns template IDs, names, and board references. Service templates define pre-configured ticket settings that can be applied when creating new tickets. Use this to discover available templates before applying them. |
cw_list_survey_results |
Free | Read-only | [ConnectWise] List all results for a specific survey. Returns survey response details including scores, comments, and associated tickets. Requires a valid survey ID -- use cw_discover_surveys to find IDs. |
cw_discover_board_teams parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
boardId |
integer | yes | The numeric board ID. Use cw_discover_boards to find valid IDs. | |
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='New'", "company/id=123 and priority/name!='Low'". Use '/' for nested fields, 'and'/'or' for boolean logic. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_discover_boards parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='New'", "company/id=123 and priority/name!='Low'". Use '/' for nested fields, 'and'/'or' for boolean logic. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_discover_codes parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='New'", "company/id=123 and priority/name!='Low'". Use '/' for nested fields, 'and'/'or' for boolean logic. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_discover_impacts parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='New'", "company/id=123 and priority/name!='Low'". Use '/' for nested fields, 'and'/'or' for boolean logic. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_discover_items parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
boardId |
integer | yes | The numeric board ID. Use cw_discover_boards to find valid IDs. | |
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='New'", "company/id=123 and priority/name!='Low'". Use '/' for nested fields, 'and'/'or' for boolean logic. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_discover_priorities parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='New'", "company/id=123 and priority/name!='Low'". Use '/' for nested fields, 'and'/'or' for boolean logic. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_discover_service_locations parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='New'", "company/id=123 and priority/name!='Low'". Use '/' for nested fields, 'and'/'or' for boolean logic. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_discover_severities parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='New'", "company/id=123 and priority/name!='Low'". Use '/' for nested fields, 'and'/'or' for boolean logic. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_discover_sla_priorities parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
slaId |
integer | yes | The SLA ID to list priorities for. Use cw_discover_slas to find valid IDs. |
cw_discover_slas parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='New'", "company/id=123 and priority/name!='Low'". Use '/' for nested fields, 'and'/'or' for boolean logic. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_discover_sources parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='New'", "company/id=123 and priority/name!='Low'". Use '/' for nested fields, 'and'/'or' for boolean logic. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_discover_statuses parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
boardId |
integer | yes | The numeric board ID. Use cw_discover_boards to find valid IDs. | |
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='New'", "company/id=123 and priority/name!='Low'". Use '/' for nested fields, 'and'/'or' for boolean logic. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_discover_subtypes parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
boardId |
integer | yes | The numeric board ID. Use cw_discover_boards to find valid IDs. | |
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='New'", "company/id=123 and priority/name!='Low'". Use '/' for nested fields, 'and'/'or' for boolean logic. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_discover_surveys parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='New'", "company/id=123 and priority/name!='Low'". Use '/' for nested fields, 'and'/'or' for boolean logic. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_discover_types parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
boardId |
integer | yes | The numeric board ID. Use cw_discover_boards to find valid IDs. | |
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='New'", "company/id=123 and priority/name!='Low'". Use '/' for nested fields, 'and'/'or' for boolean logic. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_get_board parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric board ID. Use cw_discover_boards to find valid IDs. |
cw_get_priority parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric priority ID. Use cw_discover_priorities to find valid IDs. |
cw_get_service_template parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric service template ID. Use cw_list_service_templates to find valid IDs. |
cw_get_sla parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric SLA ID. Use cw_discover_slas to find valid IDs. |
cw_list_service_templates parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='New'", "company/id=123 and priority/name!='Low'". Use '/' for nested fields, 'and'/'or' for boolean logic. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_survey_results parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number for pagination (default 1). |
pageSize |
integer | no | 50 | Number of results per page (default 50, max 200). |
surveyId |
integer | yes | The survey ID to list results for. Use cw_discover_surveys to find valid IDs. |
Stopwatches
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_create_ticket_stopwatch |
Pro | Write | [ConnectWise] Create a new ticket stopwatch. Starts tracking time against a service ticket in real time. Requires a member and ticket reference. Returns the created stopwatch with its assigned ID. |
cw_get_ticket_stopwatch |
Free | Read-only | [ConnectWise] Retrieve a single ticket stopwatch by ID. Returns full stopwatch details including member, ticket reference, status, start time, and elapsed duration. Requires a valid stopwatch ID — use cw_list_ticket_stopwatches to find IDs. |
cw_list_activity_stopwatches |
Free | Read-only | [ConnectWise] List activity stopwatches with optional filtering. Returns paginated stopwatch summaries including ID, member, activity reference, status, and elapsed time. Activity stopwatches track real-time work duration against sales activities. |
cw_list_member_stopwatches |
Free | Read-only | [ConnectWise] List all ticket stopwatches for a specific member. Useful for reviewing a technician's active and recent time tracking via stopwatches. Returns both running and stopped stopwatches. |
cw_list_running_stopwatches |
Free | Read-only | [ConnectWise] List all currently running ticket stopwatches. Returns active stopwatch records with member, ticket reference, and elapsed time. Useful for monitoring which technicians are actively working on tickets. |
cw_list_ticket_stopwatches |
Free | Read-only | [ConnectWise] List ticket stopwatches with optional filtering. Returns paginated stopwatch summaries including ID, member, ticket reference, status, and elapsed time. Stopwatches track real-time work duration against service tickets. |
cw_search_ticket_stopwatches |
Free | Read-only | [ConnectWise] Search ticket stopwatches by member identifier. Returns matching stopwatch records. Use this when you want to find running or recent stopwatches for a specific member. |
cw_update_ticket_stopwatch |
Pro | Write | [ConnectWise] Update an existing ticket stopwatch using JSON Patch operations. Use this to stop, pause, or modify a running stopwatch. Requires a valid stopwatch ID — use cw_list_ticket_stopwatches to find IDs. Returns the updated stopwatch. |
cw_create_ticket_stopwatch parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Stopwatch fields as JSON. Required: member ({"identifier": "jsmith"}), ticket reference. Example: {"member": {"identifier": "jsmith"}, "serviceTicket": {"id": 123}, "status": "Running"} |
cw_get_ticket_stopwatch parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise ticket stopwatch ID. |
cw_list_activity_stopwatches parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "member/identifier='jsmith'", "status='Running'". Use '/' for nested fields. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_member_stopwatches parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
memberIdentifier |
string | yes | The ConnectWise member identifier (e.g., 'jsmith'). | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_running_stopwatches parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_ticket_stopwatches parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "member/identifier='jsmith'", "status='Running'". Use '/' for nested fields. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_search_ticket_stopwatches parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
search |
string | yes | Search text to match against member identifier. |
cw_update_ticket_stopwatch parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise ticket stopwatch ID to update. | |
patchJson |
string | yes | JSON array of patch operations. Example: [{"op": "replace", "path": "status", "value": "Stopped"}] |
Companies
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_count_companies |
Free | Read-only | [ConnectWise] Get total count of companies matching optional conditions. Returns a count object. Useful for pagination planning or dashboards. |
cw_create_company |
Pro | Write | [ConnectWise] Create a new company record. Returns the created company with its assigned ID. The JSON must include at minimum 'name' and 'identifier'. Use cw_discover_company_statuses and cw_discover_company_types to find valid reference values. |
cw_delete_company |
Pro | Destructive | [ConnectWise] Permanently delete a company by ID. This is irreversible and will fail if the company has associated records. Verify the company ID with cw_get_company before deleting. |
cw_get_company |
Free | Read-only | [ConnectWise] Retrieve full details for a single company by ID. Returns company info including name, status, type, address, phone, and custom fields. Requires a valid company ID -- use cw_list_companies or cw_search_companies to find IDs. |
cw_list_companies |
Free | Read-only | [ConnectWise] List companies with optional filtering, ordering, and pagination. Returns company summaries including ID, name, status, and type. Use this to discover company IDs for filtering tickets, contacts, configurations, and other company-scoped data. |
cw_list_customer_companies |
Free | Read-only | [ConnectWise] List active customer companies. Returns companies where status is 'Active' and type is 'Customer'. Useful for client roster views, billing reviews, and service reporting. |
cw_list_prospect_companies |
Free | Read-only | [ConnectWise] List companies with type 'Prospect'. Useful for sales pipeline reviews -- shows companies that are potential customers but not yet active clients. |
cw_merge_companies |
Pro | Destructive | [ConnectWise] Merge a company into another company. All associated records (tickets, contacts, agreements, etc.) are moved to the target company. This is irreversible -- use cw_get_company_usages to review impact before merging. The source company is deleted after the merge. |
cw_search_companies |
Free | Read-only | [ConnectWise] Search companies by name or identifier. Returns matching companies ranked by relevance. Use this when you know the company name but not the ID. |
cw_update_company |
Pro | Write | [ConnectWise] Update an existing company using JSON Patch operations. Returns the updated company. Use cw_get_company to check current values before updating. |
cw_count_companies parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | Optional ConnectWise conditions filter. ConnectWise filter grammar (NOT SQL or OData). Form: field op value, joined by 'and'/'or', grouped with ( ). Nested fields use '/': status/name, company/id, company/identifier, owner/id. Operators: =, !=, <, <=, >, >=, 'contains' (substring), 'like' (with % wildcard), 'in (...)'. Quote string values with single quotes, e.g. status/name='Open' (double quotes also work but must be escaped inside JSON). Dates go in square brackets: lastUpdated>[2026-01-01T00:00:00Z]. Booleans and null are bare keywords: closedFlag=false, owner/id=null. Examples: status/name='Open' and closedFlag=false ; company/id=123 and priority/name!='Low' ; summary contains 'vpn'. Avoid SQL: no leading WHERE, no '==' (use '='), do not leave string values unquoted. |
cw_create_company parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the company to create. Example: {"name": "Acme Corp", "identifier": "AcmeCorp", "status": {"id": 1}, "type": {"id": 1}, "site": {"name": "Main"}, "phoneNumber": "555-0100"}. |
cw_delete_company parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The ConnectWise company ID to delete. |
cw_get_company parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The ConnectWise company ID. |
cw_list_companies parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | Optional ConnectWise conditions filter. ConnectWise filter grammar (NOT SQL or OData). Form: field op value, joined by 'and'/'or', grouped with ( ). Nested fields use '/': status/name, company/id, company/identifier, owner/id. Operators: =, !=, <, <=, >, >=, 'contains' (substring), 'like' (with % wildcard), 'in (...)'. Quote string values with single quotes, e.g. status/name='Open' (double quotes also work but must be escaped inside JSON). Dates go in square brackets: lastUpdated>[2026-01-01T00:00:00Z]. Booleans and null are bare keywords: closedFlag=false, owner/id=null. Examples: status/name='Open' and closedFlag=false ; company/id=123 and priority/name!='Low' ; summary contains 'vpn'. Avoid SQL: no leading WHERE, no '==' (use '='), do not leave string values unquoted. |
orderBy |
string | no | null | Order results by field. Examples: "name asc", "id desc". |
page |
integer | no | 1 | Page number for pagination (default 1). |
pageSize |
integer | no | 50 | Number of results per page (default 50, max 200). |
cw_list_customer_companies parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_prospect_companies parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_merge_companies parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object specifying the merge target. Example: {"toCompanyId": 456}. | |
id |
integer | yes | The ConnectWise company ID to merge FROM (this company will be deleted). |
cw_search_companies parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number for pagination (default 1). |
pageSize |
integer | no | 50 | Number of results per page (default 50, max 200). |
search |
string | yes | Search text to match against company name and identifier. |
cw_update_company parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The ConnectWise company ID to update. | |
patchJson |
string | yes | JSON array of patch operations. Example: [{"op": "replace", "path": "/name", "value": "Acme Corp Updated"}, {"op": "replace", "path": "/phoneNumber", "value": "555-0200"}]. |
Company Sites & Notes
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_create_company_note |
Pro | Write | [ConnectWise] Create a new note on a company. Returns the created note with its assigned ID. Use cw_discover_company_note_types to find valid note type references. |
cw_create_company_site |
Pro | Write | [ConnectWise] Create a new site for a company. Returns the created site with its assigned ID. The JSON must include at minimum a 'name'. |
cw_get_company_site |
Free | Read-only | [ConnectWise] Retrieve full details for a single company site by company ID and site ID. Returns site info including name, address, city, state, zip, and phone number. |
cw_list_company_notes |
Free | Read-only | [ConnectWise] List all notes for a company. Returns note details including ID, text, type, and timestamps. Use conditions to filter by note type or date. Requires a valid company ID -- use cw_list_companies to find IDs. |
cw_list_company_sites |
Free | Read-only | [ConnectWise] List all sites for a company. Returns site details including name, address, and primary flag. Requires a valid company ID -- use cw_list_companies or cw_search_companies to find IDs. |
cw_update_company_note |
Pro | Write | [ConnectWise] Update an existing company note using JSON Patch operations. Returns the updated note. Use cw_list_company_notes to find valid note IDs. |
cw_update_company_site |
Pro | Write | [ConnectWise] Update an existing company site using JSON Patch operations. Returns the updated site. Use cw_get_company_site to check current values before updating. |
cw_create_company_note parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The ConnectWise company ID to add the note to. | |
fieldsJson |
string | yes | JSON object for the note to create. Example: {"text": "Important client note", "type": {"id": 1}, "flagged": false}. |
cw_create_company_site parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The ConnectWise company ID to add the site to. | |
fieldsJson |
string | yes | JSON object for the site to create. Example: {"name": "Branch Office", "addressLine1": "123 Main St", "city": "New York", "stateReference": {"identifier": "NY"}, "zip": "10001"}. |
cw_get_company_site parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The ConnectWise company ID. | |
siteId |
integer | yes | The ConnectWise site ID. |
cw_list_company_notes parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The ConnectWise company ID. | |
conditions |
string | no | null | ConnectWise conditions filter. Examples: "type/name='General'". Use '/' for nested fields. |
page |
integer | no | 1 | Page number for pagination (default 1). |
pageSize |
integer | no | 50 | Number of results per page (default 50, max 200). |
cw_list_company_sites parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The ConnectWise company ID to list sites for. |
cw_update_company_note parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The ConnectWise company ID. | |
noteId |
integer | yes | The note ID to update. | |
patchJson |
string | yes | JSON array of patch operations. Example: [{"op": "replace", "path": "/text", "value": "Updated note text"}, {"op": "replace", "path": "/flagged", "value": true}]. |
cw_update_company_site parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The ConnectWise company ID. | |
patchJson |
string | yes | JSON array of patch operations. Example: [{"op": "replace", "path": "/name", "value": "Updated Branch"}, {"op": "replace", "path": "/city", "value": "Chicago"}]. | |
siteId |
integer | yes | The ConnectWise site ID to update. |
Contacts
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_count_contacts |
Free | Read-only | [ConnectWise] Get total count of contacts matching optional conditions. Returns a count object. Useful for pagination planning or dashboards. |
cw_create_contact |
Pro | Write | [ConnectWise] Create a new contact record. Returns the created contact with its assigned ID. The JSON must include at minimum 'firstName', 'lastName', and a company reference. |
cw_create_contact_communication |
Pro | Write | [ConnectWise] Add a new communication item (email, phone, fax) to a contact. Returns the created communication with its assigned ID. |
cw_create_contact_note |
Pro | Write | [ConnectWise] Create a new note on a contact. Returns the created note with its assigned ID. Requires a valid contact ID -- use cw_list_contacts to find IDs. |
cw_delete_contact |
Pro | Destructive | [ConnectWise] Permanently delete a contact by ID. This is irreversible. Verify the contact ID with cw_get_contact before deleting. |
cw_get_contact |
Free | Read-only | [ConnectWise] Retrieve full details for a single contact by ID. Returns contact info including name, company, title, email, phone, and communication items. Requires a valid contact ID -- use cw_list_contacts or cw_search_contacts to find IDs. |
cw_list_company_contacts |
Free | Read-only | [ConnectWise] List all contacts for a specific company. A convenience tool that filters contacts to a single company by ID. Useful for viewing the full contact roster for a client before creating tickets or communications. |
cw_list_contact_communications |
Free | Read-only | [ConnectWise] List all communication items (email, phone, fax) for a contact. Returns communication type, value, and default flags. Requires a valid contact ID. |
cw_list_contact_notes |
Free | Read-only | [ConnectWise] List all notes for a contact. Returns note text, type, and timestamps. Requires a valid contact ID. |
cw_list_contacts |
Free | Read-only | [ConnectWise] List contacts with optional filtering, ordering, and pagination. Returns contact summaries including ID, name, company, email, and phone. Use this to discover contact IDs for communication records or ticket associations. |
cw_search_contacts |
Free | Read-only | [ConnectWise] Search contacts by name or communication value (email, phone). Returns matching contacts. Use this when you know the contact's name or email but not the ID. |
cw_update_contact |
Pro | Write | [ConnectWise] Update an existing contact using JSON Patch operations. Returns the updated contact. Use cw_get_contact to check current values before updating. |
cw_count_contacts parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | Optional ConnectWise conditions filter. ConnectWise filter grammar (NOT SQL or OData). Form: field op value, joined by 'and'/'or', grouped with ( ). Nested fields use '/': status/name, company/id, company/identifier, owner/id. Operators: =, !=, <, <=, >, >=, 'contains' (substring), 'like' (with % wildcard), 'in (...)'. Quote string values with single quotes, e.g. status/name='Open' (double quotes also work but must be escaped inside JSON). Dates go in square brackets: lastUpdated>[2026-01-01T00:00:00Z]. Booleans and null are bare keywords: closedFlag=false, owner/id=null. Examples: status/name='Open' and closedFlag=false ; company/id=123 and priority/name!='Low' ; summary contains 'vpn'. Avoid SQL: no leading WHERE, no '==' (use '='), do not leave string values unquoted. |
cw_create_contact parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the contact to create. Example: {"firstName": "John", "lastName": "Doe", "company": {"id": 123}, "title": "IT Manager", "communicationItems": [{"type": {"id": 1}, "value": "john@example.com", "communicationType": "Email"}]}. |
cw_create_contact_communication parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
contactId |
integer | yes | The ConnectWise contact ID to add the communication to. | |
fieldsJson |
string | yes | JSON object for the communication to create. Example: {"type": {"id": 1}, "value": "john@example.com", "communicationType": "Email", "defaultFlag": true}. |
cw_create_contact_note parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
contactId |
integer | yes | The ConnectWise contact ID to add the note to. | |
fieldsJson |
string | yes | JSON object for the note to create. Example: {"text": "Spoke with contact about renewal", "type": {"id": 1}, "flagged": false}. |
cw_delete_contact parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The ConnectWise contact ID to delete. |
cw_get_contact parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The ConnectWise contact ID. |
cw_list_company_contacts parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The numeric ConnectWise company ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_contact_communications parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
contactId |
integer | yes | The ConnectWise contact ID. |
cw_list_contact_notes parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
contactId |
integer | yes | The ConnectWise contact ID. |
cw_list_contacts parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | Optional ConnectWise conditions filter. ConnectWise filter grammar (NOT SQL or OData). Form: field op value, joined by 'and'/'or', grouped with ( ). Nested fields use '/': status/name, company/id, company/identifier, owner/id. Operators: =, !=, <, <=, >, >=, 'contains' (substring), 'like' (with % wildcard), 'in (...)'. Quote string values with single quotes, e.g. status/name='Open' (double quotes also work but must be escaped inside JSON). Dates go in square brackets: lastUpdated>[2026-01-01T00:00:00Z]. Booleans and null are bare keywords: closedFlag=false, owner/id=null. Examples: status/name='Open' and closedFlag=false ; company/id=123 and priority/name!='Low' ; summary contains 'vpn'. Avoid SQL: no leading WHERE, no '==' (use '='), do not leave string values unquoted. |
orderBy |
string | no | null | Order results by field. Examples: "firstName asc", "lastName desc". |
page |
integer | no | 1 | Page number for pagination (default 1). |
pageSize |
integer | no | 50 | Number of results per page (default 50, max 200). |
cw_search_contacts parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number for pagination (default 1). |
pageSize |
integer | no | 50 | Number of results per page (default 50, max 200). |
search |
string | yes | Search text to match against first name, last name, or communication items (email, phone). |
cw_update_contact parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The ConnectWise contact ID to update. | |
patchJson |
string | yes | JSON array of patch operations. Example: [{"op": "replace", "path": "/title", "value": "CTO"}, {"op": "replace", "path": "/firstName", "value": "Jonathan"}]. |
Configurations (Assets)
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_count_configurations |
Free | Read-only | [ConnectWise] Get total count of configurations matching optional conditions. Returns a count object. Useful for pagination planning or asset inventory dashboards. |
cw_create_configuration |
Pro | Write | [ConnectWise] Create a new configuration (asset) record. Returns the created configuration with its assigned ID. The JSON must include at minimum 'name', a company reference, and a type reference. Use cw_discover_configuration_types and cw_discover_configuration_statuses to find valid reference values. |
cw_delete_configuration |
Pro | Destructive | [ConnectWise] Permanently delete a configuration (asset) by ID. This is irreversible. Verify the configuration ID with cw_get_configuration before deleting. |
cw_get_configuration |
Free | Read-only | [ConnectWise] Retrieve full details for a single configuration (asset) by ID. Returns configuration info including name, type, status, company, serial number, and custom fields. Requires a valid configuration ID -- use cw_list_configurations to find IDs. |
cw_list_active_configurations |
Free | Read-only | [ConnectWise] List all configurations (assets) with active status. Returns only assets where status is 'Active', excluding retired or decommissioned equipment. Useful for current asset inventory views. |
cw_list_company_configurations |
Free | Read-only | [ConnectWise] List all configurations (assets) for a specific company. A convenience tool that filters configurations to a single company by ID. Useful for asset inventory reviews or pre-ticket context gathering. |
cw_list_configurations |
Free | Read-only | [ConnectWise] List configurations (assets/CIs) with optional filtering, ordering, and pagination. Returns configuration summaries including ID, name, type, status, company, and serial number. Use this to discover configuration IDs for asset management. |
cw_search_configurations |
Free | Read-only | [ConnectWise] Search configurations (assets) by name, serial number, or MAC address. Returns matching configuration records. Use this when you know a device name, serial number, or MAC but not the numeric ID. |
cw_update_configuration |
Pro | Write | [ConnectWise] Update an existing configuration (asset) using JSON Patch operations. Returns the updated configuration. Use cw_get_configuration to check current values before updating. |
cw_count_configurations parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='Active'", "company/id=123". Use '/' for nested fields. |
cw_create_configuration parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the configuration to create. Example: {"name": "DESKTOP-001", "company": {"id": 123}, "type": {"id": 5}, "status": {"id": 1}, "serialNumber": "SN12345", "modelNumber": "OptiPlex 7090"}. |
cw_delete_configuration parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The ConnectWise configuration ID to delete. |
cw_get_configuration parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The ConnectWise configuration ID. |
cw_list_active_configurations parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_company_configurations parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The numeric ConnectWise company ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_configurations parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='Active'", "company/id=123". Use '/' for nested fields. |
orderBy |
string | no | null | Order results by field. Examples: "name asc", "id desc". |
page |
integer | no | 1 | Page number for pagination (default 1). |
pageSize |
integer | no | 50 | Number of results per page (default 50, max 200). |
cw_search_configurations parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
search |
string | yes | Search text to match against configuration name, serial number, or MAC address. |
cw_update_configuration parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The ConnectWise configuration ID to update. | |
patchJson |
string | yes | JSON array of patch operations. Example: [{"op": "replace", "path": "/name", "value": "DESKTOP-002"}, {"op": "replace", "path": "/serialNumber", "value": "SN67890"}]. |
Company & Contact Discovery
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_discover_company_groups |
Free | Read-only | [ConnectWise] List all available company groups. Returns group IDs and names. Company groups are used for categorizing and organizing companies into logical collections (e.g., by region, service tier, or industry). |
cw_discover_company_note_types |
Free | Read-only | [ConnectWise] List all available company note types (e.g., General, Billing, Technical). Returns type IDs and names. Use these IDs when creating company notes with cw_create_company_note. |
cw_discover_company_statuses |
Free | Read-only | [ConnectWise] List all available company statuses (e.g., Active, Inactive). Returns status IDs and names. Use these IDs when creating or filtering companies by status. |
cw_discover_company_types |
Free | Read-only | [ConnectWise] List all available company types (e.g., Client, Prospect, Vendor). Returns type IDs and names. Use these IDs when creating or filtering companies by type. |
cw_discover_configuration_statuses |
Free | Read-only | [ConnectWise] List all available configuration (asset) statuses (e.g., Active, Retired, In Repair). Returns status IDs and names. Use these IDs when creating or filtering configurations by status. |
cw_discover_configuration_type_questions |
Free | Read-only | [ConnectWise] List all questions (custom fields) defined for a configuration type. Returns question details including field type, options, and requirements. Requires a valid configuration type ID -- use cw_discover_configuration_types to find IDs. |
cw_discover_configuration_types |
Free | Read-only | [ConnectWise] List all available configuration (asset) types (e.g., Desktop, Server, Network Device). Returns type IDs and names. Use these IDs when creating or filtering configurations by type. |
cw_discover_contact_departments |
Free | Read-only | [ConnectWise] List all available contact departments (e.g., IT, Finance, Operations). Returns department IDs and names. Use these IDs when creating or filtering contacts by department. |
cw_discover_contact_groups |
Free | Read-only | [ConnectWise] List all available contact groups. Returns group IDs and names. Contact groups are used for categorizing contacts into logical collections for marketing, communication, or reporting purposes. |
cw_discover_contact_relationships |
Free | Read-only | [ConnectWise] List all relationships for a specific contact. Returns relationship details including related contact, company, and relationship type. Requires a valid contact ID -- use cw_list_contacts to find IDs. |
cw_discover_contact_types |
Free | Read-only | [ConnectWise] List all available contact types (e.g., Primary, Billing, Technical). Returns type IDs and names. Use these IDs when creating or filtering contacts by type. |
cw_discover_portal_configurations |
Free | Read-only | [ConnectWise] List all portal configurations. Returns portal setup details including URL, login settings, and company-specific portal configuration. Useful for understanding client portal access and settings. |
cw_get_company_usages |
Free | Read-only | [ConnectWise] Get usage counts for a company showing how many related records exist (tickets, contacts, configurations, etc.). Returns a breakdown of record counts by type. Useful for assessing impact before merging or deleting a company. |
cw_list_active_companies |
Free | Read-only | [ConnectWise] List all active companies. A convenience filter that returns only companies with an Active status. Useful for quick client roster views or populating company dropdown lists. |
cw_list_company_teams |
Free | Read-only | [ConnectWise] List teams assigned to a specific company. Returns team details including team role, member assignments, and contact info. Requires a valid company ID -- use cw_list_companies or cw_search_companies to find IDs. |
cw_discover_configuration_type_questions parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
typeId |
integer | yes | The configuration type ID. Use cw_discover_configuration_types to find valid IDs. |
cw_discover_contact_relationships parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
contactId |
integer | yes | The ConnectWise contact ID to list relationships for. |
cw_get_company_usages parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The ConnectWise company ID. |
cw_list_active_companies parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_company_teams parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The ConnectWise company ID. | |
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
Agreements
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_count_agreements |
Free | Read-only | [ConnectWise] Get total count of agreements matching optional conditions. Returns a count object. Useful for pagination planning or revenue dashboards. |
cw_create_agreement |
Pro | Write | [ConnectWise] Create a new agreement (contract). Returns the created agreement with its assigned ID. The JSON must include at minimum 'name', a company reference, and a type reference. Use cw_discover_agreement_types and cw_discover_billing_cycles to find valid reference values. |
cw_create_agreement_addition |
Pro | Write | [ConnectWise] Add a new addition (line item) to an agreement. Returns the created addition with its assigned ID. The JSON must include at minimum a product reference and quantity. |
cw_delete_agreement |
Pro | Destructive | [ConnectWise] Permanently delete an agreement by ID. This is irreversible and will fail if the agreement has associated additions or billing records. Verify the agreement ID with cw_get_agreement before deleting. |
cw_get_agreement |
Free | Read-only | [ConnectWise] Retrieve full details for a single agreement by ID. Returns agreement info including name, type, company, billing cycle, start/end dates, and amounts. Requires a valid agreement ID -- use cw_list_agreements to find IDs. |
cw_list_active_agreements |
Free | Read-only | [ConnectWise] List all active (non-cancelled, non-expired) agreements. A convenience filter that returns only agreements where cancelledFlag=false. Useful for quick MRR reviews or client contract overviews. |
cw_list_agreement_additions |
Free | Read-only | [ConnectWise] List all additions (line items) for an agreement. Returns addition details including product, quantity, amount, and billing info. Requires a valid agreement ID -- use cw_list_agreements to find IDs. |
cw_list_agreements |
Free | Read-only | [ConnectWise] List agreements (contracts) with optional filtering, ordering, and pagination. Returns agreement summaries including ID, name, type, company, and billing details. Use this to discover agreement IDs for additions, billing analysis, or profitability review. |
cw_list_company_agreements |
Free | Read-only | [ConnectWise] List all agreements for a specific company. A convenience tool that filters agreements to a single company. Useful for reviewing a client's contract portfolio. |
cw_list_expiring_agreements |
Free | Read-only | [ConnectWise] List agreements expiring within a specified number of days. Useful for proactive renewal management -- returns active agreements whose endDate falls within the given window. Default is 90 days. |
cw_search_agreements |
Free | Read-only | [ConnectWise] Search agreements by name or company name. Returns matching agreements ranked by relevance. Use this when looking for agreements by keyword rather than structured filtering with cw_list_agreements. |
cw_update_agreement |
Pro | Write | [ConnectWise] Update an existing agreement using JSON Patch operations. Returns the updated agreement. Use cw_get_agreement to check current values before updating. |
cw_count_agreements parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='Active'", "company/id=123". Use '/' for nested fields. |
cw_create_agreement parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the agreement to create. Example: {"name": "Managed Services", "company": {"id": 123}, "type": {"id": 1}, "startDate": "2025-01-01T00:00:00Z", "billCycleId": {"id": 1}, "billAmount": 1500.00}. |
cw_create_agreement_addition parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
agreementId |
integer | yes | The ConnectWise agreement ID to add the addition to. | |
fieldsJson |
string | yes | JSON object for the addition to create. Example: {"product": {"id": 10}, "quantity": 5, "lessIncluded": 0, "unitPrice": 25.00, "billCustomer": "Billable", "effectiveDate": "2025-01-01T00:00:00Z"}. |
cw_delete_agreement parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The ConnectWise agreement ID to delete. |
cw_get_agreement parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The ConnectWise agreement ID. |
cw_list_active_agreements parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_agreement_additions parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
agreementId |
integer | yes | The ConnectWise agreement ID. |
cw_list_agreements parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='Active'", "company/id=123". Use '/' for nested fields. |
orderBy |
string | no | null | Order results by field. Examples: "name asc", "id desc". |
page |
integer | no | 1 | Page number for pagination (default 1). |
pageSize |
integer | no | 50 | Number of results per page (default 50, max 200). |
cw_list_company_agreements parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The numeric ConnectWise company ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_expiring_agreements parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
days |
integer | no | 90 | Number of days from today to check for expiring agreements (default 90). |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_search_agreements parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
search |
string | yes | Search term to match against agreement name or company name. |
cw_update_agreement parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The ConnectWise agreement ID to update. | |
patchJson |
string | yes | JSON array of patch operations. Example: [{"op": "replace", "path": "/name", "value": "Updated Services"}, {"op": "replace", "path": "/billAmount", "value": 2000.00}]. |
Agreement Sub-Resources
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_copy_agreement |
Pro | Write | [ConnectWise] Create a copy of an existing agreement. Returns the newly created agreement with a new ID. The copy includes all additions, sites, work roles, and work types from the original. Useful for creating similar agreements for new clients. |
cw_create_agreement_adjustment |
Pro | Write | [ConnectWise] Create a new adjustment on an agreement. Returns the created adjustment with its assigned ID. Adjustments modify the agreement billing total for a given period. |
cw_create_agreement_site |
Pro | Write | [ConnectWise] Add a site to an agreement's coverage. Returns the created agreement site association. Use cw_list_company_sites to find valid site IDs. |
cw_create_agreement_workrole |
Pro | Write | [ConnectWise] Add a work role to an agreement. Returns the created work role with its assigned ID. Use cw_discover_work_roles to find valid work role references. |
cw_create_agreement_worktype |
Pro | Write | [ConnectWise] Add a work type to an agreement. Returns the created work type with its assigned ID. Use cw_discover_work_types to find valid work type references. |
cw_get_agreement_recaps |
Free | Read-only | [ConnectWise] Get recap/summary data for agreements. Returns agreement financial summaries including billed amounts, adjustments, and profit information. Use conditions to filter to specific agreements or date ranges. |
cw_list_agreement_adjustments |
Free | Read-only | [ConnectWise] List all adjustments for an agreement. Returns adjustment details including amount, description, and effective date. Adjustments modify the agreement billing total. Requires a valid agreement ID -- use cw_list_agreements to find IDs. |
cw_list_agreement_board_defaults |
Free | Read-only | [ConnectWise] List all board defaults configured for an agreement. Returns board default details including board reference, default work role, and work type. Board defaults define which settings are used when time is entered against the agreement on a specific service board. |
cw_list_agreement_sites |
Free | Read-only | [ConnectWise] List all sites covered by an agreement. Returns site details including company site reference and coverage info. Requires a valid agreement ID -- use cw_list_agreements to find IDs. |
cw_list_agreement_workroles |
Free | Read-only | [ConnectWise] List all work roles configured for an agreement. Returns work role details including rate, effective date, and ending date. Work roles define hourly rates for different staff roles under the agreement. |
cw_list_agreement_worktypes |
Free | Read-only | [ConnectWise] List all work types configured for an agreement. Returns work type details including rate, effective date, and billing method. Work types define rates for different categories of work (e.g., remote, on-site) under the agreement. |
cw_update_agreement_addition |
Pro | Write | [ConnectWise] Update an existing addition (line item) on an agreement using JSON Patch operations. Returns the updated addition. Use cw_list_agreement_additions to find valid addition IDs. |
cw_copy_agreement parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
agreementId |
integer | yes | The ConnectWise agreement ID to copy. |
cw_create_agreement_adjustment parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
agreementId |
integer | yes | The ConnectWise agreement ID to add the adjustment to. | |
fieldsJson |
string | yes | JSON object for the adjustment to create. Example: {"amount": -50.00, "description": "Discount for service outage", "effectiveDate": "2025-03-01T00:00:00Z"}. |
cw_create_agreement_site parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
agreementId |
integer | yes | The ConnectWise agreement ID. | |
fieldsJson |
string | yes | JSON object for the site association. Example: {"company": {"id": 123}, "site": {"id": 1}}. |
cw_create_agreement_workrole parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
agreementId |
integer | yes | The ConnectWise agreement ID. | |
fieldsJson |
string | yes | JSON object for the work role. Example: {"workRole": {"id": 5}, "rate": 150.00, "effectiveDate": "2025-01-01T00:00:00Z"}. |
cw_create_agreement_worktype parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
agreementId |
integer | yes | The ConnectWise agreement ID. | |
fieldsJson |
string | yes | JSON object for the work type. Example: {"workType": {"id": 3}, "rate": 125.00, "effectiveDate": "2025-01-01T00:00:00Z"}. |
cw_get_agreement_recaps parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "id=123", "company/id=456". Use '/' for nested fields. |
page |
integer | no | 1 | Page number for pagination (default 1). |
pageSize |
integer | no | 50 | Number of results per page (default 50, max 200). |
cw_list_agreement_adjustments parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
agreementId |
integer | yes | The ConnectWise agreement ID. |
cw_list_agreement_board_defaults parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
agreementId |
integer | yes | The ConnectWise agreement ID. |
cw_list_agreement_sites parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
agreementId |
integer | yes | The ConnectWise agreement ID. |
cw_list_agreement_workroles parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
agreementId |
integer | yes | The ConnectWise agreement ID. |
cw_list_agreement_worktypes parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
agreementId |
integer | yes | The ConnectWise agreement ID. |
cw_update_agreement_addition parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
additionId |
integer | yes | The addition ID to update. | |
agreementId |
integer | yes | The ConnectWise agreement ID. | |
patchJson |
string | yes | JSON array of patch operations. Example: [{"op": "replace", "path": "/quantity", "value": 10}, {"op": "replace", "path": "/unitPrice", "value": 30.00}]. |
Invoices
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_count_invoices |
Free | Read-only | [ConnectWise] Get a count of invoices matching optional conditions. Returns a single-record result for counting. Useful for billing dashboards or checking result set size before paginating with cw_list_invoices. |
cw_create_invoice |
Pro | Write | [ConnectWise] Create a new invoice. Returns the created invoice with its assigned ID. The JSON should include company reference and billing details. Use cw_discover_billing_terms and cw_discover_tax_codes to find valid reference values. |
cw_create_invoice_payment |
Pro | Write | [ConnectWise] Record a payment against an invoice. Returns the created payment with its assigned ID. Requires a valid invoice ID -- use cw_list_invoices to find IDs. |
cw_get_invoice |
Free | Read-only | [ConnectWise] Retrieve full details for a single invoice by ID. Returns invoice info including number, company, total, tax, date, due date, and line items. Requires a valid invoice ID -- use cw_list_invoices to find IDs. |
cw_get_invoice_pdf |
Free | Read-only | [ConnectWise] Retrieve the PDF representation of an invoice by ID. Returns the PDF content as a base64-encoded string. Requires a valid invoice ID -- use cw_list_invoices to find IDs. |
cw_list_company_invoices |
Free | Read-only | [ConnectWise] List all invoices for a specific company. A convenience tool that filters invoices to a single company by ID. Useful for reviewing a client's billing history. |
cw_list_invoice_payments |
Free | Read-only | [ConnectWise] List all payments applied to an invoice. Returns payment details including amount, date, and payment method. Requires a valid invoice ID -- use cw_list_invoices to find IDs. |
cw_list_invoices |
Free | Read-only | [ConnectWise] List invoices with optional filtering, ordering, and pagination. Returns invoice summaries including ID, invoice number, company, total, date, and status. Use this to review billing history or find specific invoices. |
cw_list_recent_invoices |
Free | Read-only | [ConnectWise] List the most recent invoices ordered by date descending. Useful for quick billing reviews -- shows the latest invoices across all companies without any filtering. |
cw_search_invoices |
Free | Read-only | [ConnectWise] Search invoices by invoice number or company name. Returns matching invoices. Use this when you know the invoice number or company name but not the numeric ID. |
cw_update_invoice |
Pro | Write | [ConnectWise] Update an existing invoice using JSON Patch operations. Returns the updated invoice. Use cw_get_invoice to check current values before updating. |
cw_count_invoices parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='Active'", "company/id=123". Use '/' for nested fields. |
cw_create_invoice parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the invoice to create. Example: {"company": {"id": 123}, "billingTerms": {"id": 1}, "dueDate": "2025-04-30T00:00:00Z"}. |
cw_create_invoice_payment parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the payment to create. Example: {"amount": 500.00, "paymentDate": "2025-03-15T00:00:00Z", "type": "Check"}. | |
invoiceId |
integer | yes | The ConnectWise invoice ID to apply the payment to. |
cw_get_invoice parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The ConnectWise invoice ID. |
cw_get_invoice_pdf parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The ConnectWise invoice ID. |
cw_list_company_invoices parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The numeric ConnectWise company ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_invoice_payments parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
invoiceId |
integer | yes | The ConnectWise invoice ID. |
cw_list_invoices parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='Active'", "company/id=123". Use '/' for nested fields. |
orderBy |
string | no | null | Order results by field. Examples: "date desc", "total asc". |
page |
integer | no | 1 | Page number for pagination (default 1). |
pageSize |
integer | no | 50 | Number of results per page (default 50, max 200). |
cw_list_recent_invoices parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_search_invoices parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
search |
string | yes | Search text to match against invoice number or company name. |
cw_update_invoice parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The ConnectWise invoice ID to update. | |
patchJson |
string | yes | JSON array of patch operations. Example: [{"op": "replace", "path": "/dueDate", "value": "2025-05-31T00:00:00Z"}, {"op": "replace", "path": "/status", "value": "Sent"}]. |
Accounting
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_count_gl_entries |
Free | Read-only | [ConnectWise] Get a count of general ledger entries matching optional conditions. Returns a single-record result for counting. Useful for financial reporting dashboards. |
cw_count_unposted_expenses |
Free | Read-only | [ConnectWise] Get a count of unposted expenses matching optional conditions. Returns a single-record result for counting. Useful for expense approval pipeline dashboards. |
cw_count_unposted_invoices |
Free | Read-only | [ConnectWise] Get a count of unposted invoices matching optional conditions. Returns a single-record result for counting. Useful for billing pipeline dashboards. |
cw_create_accounting_batch |
Pro | Write | [ConnectWise] Create a new accounting batch for grouping transactions. Returns the created batch with its assigned ID. Batches are used to organize and export financial data to external accounting systems. |
cw_discover_billing_setups |
Free | Read-only | [ConnectWise] List all billing setup configurations. Returns setup details including email templates, invoice templates, and billing defaults. Useful for understanding how billing is configured in the ConnectWise instance. |
cw_discover_billing_statuses |
Free | Read-only | [ConnectWise] List all billing statuses. Returns status IDs and names (e.g., Billed, Unbilled, Do Not Bill). Use these values when filtering invoices, time entries, or expenses by billing status. |
cw_discover_delivery_methods |
Free | Read-only | [ConnectWise] List all invoice delivery methods. Returns method IDs and names (e.g., Email, Print, Mail). Use these values when creating or updating invoices to specify how they should be delivered to customers. |
cw_get_accounting_batch |
Free | Read-only | [ConnectWise] Retrieve full details for a single accounting batch by ID. Returns batch info including name, status, transactions, and export details. Requires a valid batch ID -- use cw_list_accounting_batches to find IDs. |
cw_list_accounting_batches |
Free | Read-only | [ConnectWise] List accounting batches with optional filtering and pagination. Returns batch summaries including ID, name, status, and export date. Batches group financial transactions for export to accounting systems. |
cw_list_gl_entries |
Free | Read-only | [ConnectWise] List general ledger (GL) entries with optional filtering and pagination. Returns posted GL transactions including account, amount, and reference. Useful for financial reporting and reconciliation. |
cw_list_unposted_expenses |
Free | Read-only | [ConnectWise] List unposted (pending) expenses with optional filtering and pagination. Returns expenses that have not yet been posted to the GL. Useful for reviewing expense reports before finalizing. |
cw_list_unposted_invoices |
Free | Read-only | [ConnectWise] List unposted (pending) invoices with optional filtering and pagination. Returns invoices that have not yet been posted to the GL. Useful for reviewing billing before finalizing. |
cw_list_unposted_payments |
Free | Read-only | [ConnectWise] List unposted (pending) payments with optional filtering and pagination. Returns payments that have not yet been posted to the GL. Useful for reviewing incoming payments before finalizing. |
cw_count_gl_entries parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "glAccount/id=5". Use '/' for nested fields. |
cw_count_unposted_expenses parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "member/identifier='jsmith'". Use '/' for nested fields. |
cw_count_unposted_invoices parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "company/id=123". Use '/' for nested fields. |
cw_create_accounting_batch parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the batch to create. Example: {"name": "March 2025 Invoices"}. |
cw_get_accounting_batch parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The ConnectWise accounting batch ID. |
cw_list_accounting_batches parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status='Open'", "exportedFlag=false". Use '/' for nested fields. |
page |
integer | no | 1 | Page number for pagination (default 1). |
pageSize |
integer | no | 50 | Number of results per page (default 50, max 200). |
cw_list_gl_entries parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "glAccount/id=5", "amount>1000". Use '/' for nested fields. |
page |
integer | no | 1 | Page number for pagination (default 1). |
pageSize |
integer | no | 50 | Number of results per page (default 50, max 200). |
cw_list_unposted_expenses parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "member/identifier='jsmith'". Use '/' for nested fields. |
page |
integer | no | 1 | Page number for pagination (default 1). |
pageSize |
integer | no | 50 | Number of results per page (default 50, max 200). |
cw_list_unposted_invoices parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "company/id=123", "total>100". Use '/' for nested fields. |
page |
integer | no | 1 | Page number for pagination (default 1). |
pageSize |
integer | no | 50 | Number of results per page (default 50, max 200). |
cw_list_unposted_payments parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "company/id=123". Use '/' for nested fields. |
page |
integer | no | 1 | Page number for pagination (default 1). |
pageSize |
integer | no | 50 | Number of results per page (default 50, max 200). |
Finance Discovery
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_discover_agreement_types |
Free | Read-only | [ConnectWise] List all available agreement types (e.g., Standard, Block Time, Retainer). Returns type IDs and names. Use these IDs when creating or filtering agreements by type. |
cw_discover_billing_cycles |
Free | Read-only | [ConnectWise] List all available billing cycles (e.g., Monthly, Quarterly, Annually). Returns cycle IDs and names. Use these IDs when creating agreements with specific billing schedules. |
cw_discover_billing_terms |
Free | Read-only | [ConnectWise] List all available billing terms (e.g., Net 30, Net 60, Due on Receipt). Returns term IDs and names. Use these IDs when creating agreements or invoices with specific payment terms. |
cw_discover_currencies |
Free | Read-only | [ConnectWise] List all available currencies. Returns currency IDs, codes, symbols, and names. Use these IDs when creating agreements or invoices in specific currencies. |
cw_discover_gl_accounts |
Free | Read-only | [ConnectWise] List all available general ledger (GL) accounts. Returns account IDs, numbers, and names. Use these IDs when configuring agreement or invoice GL mappings. |
cw_discover_invoice_templates |
Free | Read-only | [ConnectWise] List all available invoice templates. Returns template IDs and names. Invoice templates control the layout and formatting of generated invoices. Use these IDs when configuring billing setups or creating invoices. |
cw_discover_tax_codes |
Free | Read-only | [ConnectWise] List all available tax codes. Returns tax code IDs, names, and rates. Use these IDs when creating agreements or invoices that require tax configuration. |
Time Entries
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_count_time_entries |
Free | Read-only | [ConnectWise] Get a count of time entries matching optional conditions. Returns the total number of matching entries without fetching data. Useful for dashboards, reporting, and checking result set size before paginating with cw_list_time_entries. |
cw_create_time_entry |
Pro | Write | [ConnectWise] Create a new time entry. Requires at minimum a member reference and either timeStart/timeEnd or actualHours. Use cw_discover_work_types and cw_discover_work_roles to find valid work type and role IDs. Returns the created time entry with its assigned ID. |
cw_delete_time_entry |
Pro | Destructive | [ConnectWise] Permanently delete a time entry by ID. This cannot be undone. Verify the entry with cw_get_time_entry before deleting. Requires a valid time entry ID — use cw_list_time_entries to find IDs. |
cw_get_time_entry |
Free | Read-only | [ConnectWise] Retrieve a single time entry by ID. Returns full time entry details including member, hours, charge-to reference, work type, work role, notes, and billable status. Requires a valid time entry ID — use cw_list_time_entries to find IDs. |
cw_list_company_time_entries |
Free | Read-only | [ConnectWise] List time entries charged to a specific company. A convenience tool that filters time entries by company ID. Useful for reviewing hours logged against a client for billing or utilization analysis. |
cw_list_member_time_entries |
Free | Read-only | [ConnectWise] List time entries for a specific member by identifier. A convenience tool that filters time entries to a single member. Useful for reviewing a technician's logged time. |
cw_list_time_entries |
Free | Read-only | [ConnectWise] List time entries with optional filtering and sorting. Returns paginated time entry summaries including member, hours, charge-to reference, work type, and billable status. Use this to review logged time across the team or for specific members/tickets. |
cw_list_today_time_entries |
Free | Read-only | [ConnectWise] List all time entries for today. Useful for daily standup reviews and monitoring current day activity across the team. |
cw_list_unbilled_time_entries |
Free | Read-only | [ConnectWise] List time entries that have not yet been billed. Returns unbilled time entry records. Useful for identifying revenue that needs to be invoiced. |
cw_search_time_entries |
Free | Read-only | [ConnectWise] Search time entries by notes content or member identifier. Returns matching time entries ranked by relevance. Use this when looking for time entries by keyword rather than structured filtering with cw_list_time_entries. |
cw_update_time_entry |
Pro | Write | [ConnectWise] Update an existing time entry using JSON Patch operations. Requires a valid time entry ID — use cw_list_time_entries to find IDs. Returns the updated time entry. |
cw_count_time_entries parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='New'", "member/identifier='jsmith'". Use '/' for nested fields. |
cw_create_time_entry parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Time entry fields as JSON. Required: member ({"identifier": "jsmith"}), and either timeStart+timeEnd or actualHours. Optional: chargeToId, chargeToType, workType, workRole, notes, billableOption. Example: {"member": {"identifier": "jsmith"}, "timeStart": "2024-01-15T09:00:00Z", "timeEnd": "2024-01-15T10:30:00Z", "notes": "Troubleshooting network issue"} |
cw_delete_time_entry parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise time entry ID to delete. Verify with cw_get_time_entry before deleting. |
cw_get_time_entry parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise time entry ID. |
cw_list_company_time_entries parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The numeric ConnectWise company ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_member_time_entries parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
memberIdentifier |
string | yes | The ConnectWise member identifier (e.g., 'jsmith'). | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_time_entries parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='New'", "member/identifier='jsmith'". Use '/' for nested fields. |
orderBy |
string | no | null | Sort order. Examples: "id desc", "timeStart asc". Use field names from the time entry object. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_today_time_entries parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_unbilled_time_entries parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_search_time_entries parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
search |
string | yes | Search term to match against time entry notes or member identifier. |
cw_update_time_entry parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise time entry ID to update. | |
patchJson |
string | yes | JSON array of patch operations. Example: [{"op": "replace", "path": "notes", "value": "Updated notes"}, {"op": "replace", "path": "actualHours", "value": 2.5}] |
Timesheets
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_count_timesheets |
Free | Read-only | [ConnectWise] Get a count of timesheets matching optional conditions. Returns a single-record result for counting. Useful for tracking timesheet submission or approval backlogs. |
cw_get_timesheet |
Free | Read-only | [ConnectWise] Retrieve a single timesheet by ID. Returns full timesheet details including member, period dates, approval status, and associated time entries. Requires a valid timesheet ID — use cw_list_timesheets to find IDs. |
cw_list_pending_timesheets |
Free | Read-only | [ConnectWise] List timesheets pending approval. A convenience filter that returns only timesheets with a 'New' or submitted status. Useful for managers reviewing timesheet approval queues. |
cw_list_timesheets |
Free | Read-only | [ConnectWise] List timesheets with optional filtering. Returns paginated timesheet summaries including member, period, status, and total hours. Timesheets aggregate time entries into approval workflows. Use this to review timesheet submissions and approval status. |
cw_search_timesheets |
Free | Read-only | [ConnectWise] Search timesheets by member name or identifier. Returns matching timesheets. Use this when you know the member but want to find their timesheet submissions. |
cw_count_timesheets parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='New'", "member/identifier='jsmith'". Use '/' for nested fields. |
cw_get_timesheet parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise timesheet ID. |
cw_list_pending_timesheets parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_timesheets parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='New'", "member/identifier='jsmith'". Use '/' for nested fields. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_search_timesheets parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
search |
string | yes | Search text to match against member identifier. |
Time Discovery
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_discover_charge_code_expense_types |
Free | Read-only | [ConnectWise] List expense types associated with a specific charge code. Returns expense type entries that define how expenses are categorized under this charge code. Requires a valid charge code ID — use cw_discover_charge_codes to find IDs. |
cw_discover_charge_codes |
Free | Read-only | [ConnectWise] List all available charge codes. Charge codes define how time is categorized for billing and reporting. Use this to find valid charge code IDs when creating time entries. |
cw_discover_time_accruals |
Free | Read-only | [ConnectWise] List all available time accruals. Time accruals track PTO, vacation, sick time, and other accrual-based time balances for members. Use this to find valid accrual IDs. Call cw_list_time_accrual_details to see individual accrual entries. |
cw_discover_work_role_locations |
Free | Read-only | [ConnectWise] List location-specific rate overrides for a work role. Returns location entries with billing rates that may differ from the work role's default rate. Requires a valid work role ID — use cw_discover_work_roles to find IDs. |
cw_discover_work_roles |
Free | Read-only | [ConnectWise] List all available work roles. Work roles define the billing rate category for time entries (e.g., Engineer, Project Manager). Use this to find valid work role IDs when creating or filtering time entries. |
cw_discover_work_types |
Free | Read-only | [ConnectWise] List all available work types. Work types categorize the kind of work performed (e.g., Remote Support, On-Site, Travel). Use this to find valid work type IDs when creating or filtering time entries. |
cw_list_time_accrual_details |
Free | Read-only | [ConnectWise] List detail entries for a specific time accrual. Returns individual accrual transactions including date, hours, and reason. Requires a valid accrual ID — use cw_discover_time_accruals to find IDs. |
cw_discover_charge_code_expense_types parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
chargeCodeId |
integer | yes | The numeric ConnectWise charge code ID. |
cw_discover_work_role_locations parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
workRoleId |
integer | yes | The numeric ConnectWise work role ID. |
cw_list_time_accrual_details parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
accrualId |
integer | yes | The numeric ConnectWise time accrual ID. |
Projects
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_count_projects |
Free | Read-only | [ConnectWise] Get a count of projects matching optional conditions. Returns the total number of matching projects without fetching data. Useful for dashboards, reporting, and checking result set size before paginating with cw_list_projects. |
cw_create_project |
Pro | Write | [ConnectWise] Create a new project. Requires at minimum a name and board reference. Call cw_discover_project_boards first to find valid board IDs. Returns the created project with its assigned ID. This creates data visible to project managers and team members. |
cw_delete_project |
Pro | Destructive | [ConnectWise] Permanently delete a project by ID. This cannot be undone and will remove all associated phases, tickets, and team member assignments. Verify the project with cw_get_project before deleting. Requires a valid project ID — use cw_list_projects to find IDs. |
cw_get_project |
Free | Read-only | [ConnectWise] Retrieve a single project by ID. Returns full project details including name, status, company, manager, budget, billing method, phases, and scheduling info. Requires a valid project ID — use cw_list_projects to find IDs. |
cw_list_active_projects |
Free | Read-only | [ConnectWise] List all active (non-closed) projects. A convenience filter that returns only projects with an active status. Useful for quick project portfolio views without needing to know status IDs. |
cw_list_company_projects |
Free | Read-only | [ConnectWise] List all projects for a specific company. A convenience tool that filters projects to a single company by ID. Useful for reviewing a client's project portfolio or planning new work. |
cw_list_overdue_projects |
Free | Read-only | [ConnectWise] List active projects that are past their estimated end date. Useful for project management oversight -- identifies projects that may need attention or schedule adjustments. |
cw_list_project_billing_rates |
Free | Read-only | [ConnectWise] List billing rates configured for a specific project. Returns rate records including work role, work type, and hourly rate. Requires a valid project ID — use cw_list_projects to find IDs. |
cw_list_project_phases |
Free | Read-only | [ConnectWise] List phases for a specific project. Returns phase summaries including ID, description, scheduled dates, and budget info. Phases break projects into manageable milestones. Requires a valid project ID — use cw_list_projects to find IDs. |
cw_list_projects |
Free | Read-only | [ConnectWise] List projects with optional filtering and sorting. Returns paginated project summaries including ID, name, status, company, manager, and budget info. Use this to browse projects or narrow results before fetching full details with cw_get_project. Call cw_discover_project_statuses and cw_discover_project_types first to learn valid filter values. |
cw_search_projects |
Free | Read-only | [ConnectWise] Search projects by name or company name. Returns matching projects ranked by relevance. Use this when looking for projects by keyword rather than structured filtering with cw_list_projects. |
cw_update_project |
Pro | Write | [ConnectWise] Update an existing project using JSON Patch operations. Requires a valid project ID — use cw_list_projects to find IDs. Returns the updated project. |
cw_count_projects parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='New'", "member/identifier='jsmith'". Use '/' for nested fields. |
cw_create_project parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Project fields as JSON. Required: {"name": "...", "board": {"id": N}}. Optional: status, company, manager, estimatedStart, estimatedEnd, billingMethod, budgetHours. Example: {"name": "Office Migration", "board": {"id": 1}, "company": {"id": 42}, "estimatedStart": "2024-01-01T00:00:00Z"} |
cw_delete_project parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise project ID to delete. Verify with cw_get_project before deleting. |
cw_get_project parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise project ID. |
cw_list_active_projects parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_company_projects parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The numeric ConnectWise company ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_overdue_projects parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_project_billing_rates parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
projectId |
integer | yes | The numeric ConnectWise project ID. |
cw_list_project_phases parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
projectId |
integer | yes | The numeric ConnectWise project ID. |
cw_list_projects parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='New'", "member/identifier='jsmith'". Use '/' for nested fields. |
orderBy |
string | no | null | Sort order. Examples: "id desc", "name asc". Use field names from the project object. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_search_projects parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
search |
string | yes | Search term to match against project name or company name. |
cw_update_project parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise project ID to update. | |
patchJson |
string | yes | JSON array of patch operations. Example: [{"op": "replace", "path": "name", "value": "Updated Project"}, {"op": "replace", "path": "status", "value": {"id": 2}}] |
Project Phases
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_create_project_phase |
Pro | Write | [ConnectWise] Create a new phase within a project. Phases break projects into manageable stages with their own schedules, budgets, and ticket assignments. Requires a valid project ID — use cw_list_projects to find IDs. Call cw_discover_phase_statuses to learn valid status values. Returns the created phase with its assigned ID. |
cw_get_project_phase |
Free | Read-only | [ConnectWise] Retrieve a single project phase by project and phase ID. Returns full phase details including description, board, status, scheduled hours, actual hours, and budget. Requires valid project and phase IDs — use cw_list_project_phases on a project to find phase IDs. |
cw_update_project_phase |
Pro | Write | [ConnectWise] Update an existing project phase using JSON Patch operations. Requires valid project and phase IDs — use cw_list_project_phases to find phase IDs. Returns the updated phase. |
cw_create_project_phase parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Phase fields as JSON. Required: {"description": "..."}. Optional: board, status, scheduledHours, budgetHours, wbsCode. Example: {"description": "Phase 1 - Discovery", "board": {"id": 5}, "scheduledHours": 40} | |
projectId |
integer | yes | The numeric ConnectWise project ID to add the phase to. |
cw_get_project_phase parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
phaseId |
integer | yes | The numeric ConnectWise phase ID within the project. | |
projectId |
integer | yes | The numeric ConnectWise project ID. |
cw_update_project_phase parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
patchJson |
string | yes | JSON array of patch operations. Example: [{"op": "replace", "path": "description", "value": "Updated Phase Name"}, {"op": "replace", "path": "scheduledHours", "value": 60}] | |
phaseId |
integer | yes | The numeric ConnectWise phase ID to update. | |
projectId |
integer | yes | The numeric ConnectWise project ID. |
Project Notes & Team
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_create_project_note |
Pro | Write | [ConnectWise] Add a note to a project. Use this to record decisions, updates, or communication history. Requires a valid project ID — use cw_list_projects to find IDs. Returns the created note with its assigned ID. |
cw_create_project_team_member |
Pro | Write | [ConnectWise] Add a team member to a project. Assigns a member with a specific work role and project role. Requires a valid project ID — use cw_list_projects to find IDs. Call cw_discover_work_roles and cw_discover_project_security_roles to find valid role IDs. Returns the created team member assignment. |
cw_list_project_contacts |
Free | Read-only | [ConnectWise] List contacts associated with a specific project. Returns contact references linked to this project including contact ID, name, and role. Requires a valid project ID — use cw_list_projects to find IDs. |
cw_list_project_notes |
Free | Read-only | [ConnectWise] List notes for a specific project. Returns note summaries including ID, text, type, and created date. Project notes capture decisions, updates, and communication history. Requires a valid project ID — use cw_list_projects to find IDs. |
cw_list_project_team_members |
Free | Read-only | [ConnectWise] List team members assigned to a specific project. Returns member summaries including ID, member reference, work role, and project role. Use this to see who is assigned to a project and their roles. Requires a valid project ID — use cw_list_projects to find IDs. |
cw_create_project_note parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Note fields as JSON. Required: {"text": "..."}. Optional: type, flagged. Example: {"text": "Kickoff meeting completed, requirements confirmed"} | |
projectId |
integer | yes | The numeric ConnectWise project ID. |
cw_create_project_team_member parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Team member fields as JSON. Required: member reference. Optional: workRole, projectRole, startDate, endDate, scheduledHours. Example: {"member": {"identifier": "jsmith"}, "workRole": {"id": 3}, "projectRole": {"id": 1}} | |
projectId |
integer | yes | The numeric ConnectWise project ID. |
cw_list_project_contacts parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
projectId |
integer | yes | The numeric ConnectWise project ID. |
cw_list_project_notes parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
projectId |
integer | yes | The numeric ConnectWise project ID. |
cw_list_project_team_members parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
projectId |
integer | yes | The numeric ConnectWise project ID. |
Project Tickets
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_count_project_tickets |
Free | Read-only | [ConnectWise] Get a count of project tickets matching optional conditions. Returns a single-record result for counting. Useful for project workload assessment. |
cw_create_project_ticket |
Pro | Write | [ConnectWise] Create a new project ticket. Requires at minimum a summary and project reference. Returns the created project ticket with its assigned ID. Use cw_list_projects to find valid project IDs and cw_discover_project_boards for board IDs. |
cw_create_project_ticket_note |
Pro | Write | [ConnectWise] Add a note to a project ticket. Use this to record updates, decisions, or communication on project work items. Requires a valid project ticket ID — use cw_list_project_tickets to find IDs. Returns the created note with its assigned ID. |
cw_get_project_ticket |
Free | Read-only | [ConnectWise] Retrieve a single project ticket by ID. Returns full ticket details including summary, status, phase, project, assigned resources, and scheduling info. Requires a valid project ticket ID — use cw_list_project_tickets to find IDs. |
cw_list_project_ticket_notes |
Free | Read-only | [ConnectWise] List notes for a specific project ticket. Returns note summaries including ID, text, type, and created date. Requires a valid project ticket ID — use cw_list_project_tickets to find IDs. |
cw_list_project_tickets |
Free | Read-only | [ConnectWise] List project tickets with optional filtering. Returns paginated project ticket summaries including ID, summary, status, phase, and assigned resources. Project tickets track work items within projects. Use cw_discover_project_boards to find valid board IDs for filtering. |
cw_search_project_tickets |
Free | Read-only | [ConnectWise] Search project tickets by summary keyword. Returns matching project tickets. Use this when you know a keyword from the ticket summary but not the numeric ID. |
cw_update_project_ticket |
Pro | Write | [ConnectWise] Update an existing project ticket using JSON Patch operations. Requires a valid project ticket ID — use cw_list_project_tickets to find IDs. Returns the updated project ticket. |
cw_count_project_tickets parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='New'", "project/id=5". Use '/' for nested fields. |
cw_create_project_ticket parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Project ticket fields as JSON. Required: {"summary": "...", "project": {"id": N}}. Optional: status, phase, assignedBy, resources, budgetHours, scheduledStart, scheduledEnd. Example: {"summary": "Configure firewall rules", "project": {"id": 5}, "phase": {"id": 1}} |
cw_create_project_ticket_note parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Note fields as JSON. Required: {"text": "..."}. Optional: detailDescriptionFlag, internalAnalysisFlag, resolutionFlag. Example: {"text": "Completed initial assessment", "detailDescriptionFlag": true} | |
ticketId |
integer | yes | The numeric ConnectWise project ticket ID. |
cw_get_project_ticket parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise project ticket ID. |
cw_list_project_ticket_notes parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
ticketId |
integer | yes | The numeric ConnectWise project ticket ID. |
cw_list_project_tickets parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='New'", "member/identifier='jsmith'". Use '/' for nested fields. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_search_project_tickets parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
search |
string | yes | Search text to match against project ticket summary. |
cw_update_project_ticket parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise project ticket ID to update. | |
patchJson |
string | yes | JSON array of patch operations. Example: [{"op": "replace", "path": "summary", "value": "Updated summary"}, {"op": "replace", "path": "status", "value": {"id": 3}}] |
Project Discovery
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_discover_phase_statuses |
Free | Read-only | [ConnectWise] List all available project phase statuses. Phase statuses define the lifecycle of project phases (e.g., Open, In Progress, Completed). Use this to find valid status IDs when creating or updating project phases. |
cw_discover_project_billing_rates |
Free | Read-only | [ConnectWise] List billing rate overrides for a specific project. Returns rate entries that define custom billing rates for this project, which may differ from the default work role rates. Requires a valid project ID — use cw_list_projects to find IDs. |
cw_discover_project_boards |
Free | Read-only | [ConnectWise] List all available project boards. Project boards organize projects into categories with their own workflows and statuses. Use this to find valid board IDs when creating projects or filtering with cw_list_projects. |
cw_discover_project_security_roles |
Free | Read-only | [ConnectWise] List all available project security roles. Security roles define what permissions team members have within a project (e.g., Project Manager, Team Member, Read Only). Use this to find valid role IDs when adding team members to projects. |
cw_discover_project_statuses |
Free | Read-only | [ConnectWise] List all available project statuses. Statuses define the lifecycle stages of projects (e.g., Open, In Progress, Completed, Closed). Use this to find valid status IDs when creating or filtering projects. |
cw_discover_project_types |
Free | Read-only | [ConnectWise] List all available project types. Project types categorize projects (e.g., Internal, Client, Infrastructure). Use this to find valid type IDs when creating or filtering projects. |
cw_get_project_template |
Free | Read-only | [ConnectWise] Retrieve a single project template by ID. Returns full template details including name, description, phases, and default settings. Requires a valid template ID — use cw_list_project_templates to find IDs. |
cw_list_project_templates |
Free | Read-only | [ConnectWise] List all available project templates. Templates provide pre-configured project structures with phases, tickets, and team assignments. Use this to find templates when creating new projects based on standard workflows. |
cw_discover_project_billing_rates parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
projectId |
integer | yes | The numeric ConnectWise project ID. |
cw_get_project_template parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise project template ID. |
Opportunities
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_convert_opportunity_to_sales_order |
Pro | Write | [ConnectWise] Convert a won sales opportunity into a sales order. Creates a new sales order based on the opportunity details including products and pricing. This is typically used after a deal is closed/won to process the order. Requires a valid opportunity ID — use cw_list_opportunities to find IDs. Returns the conversion result. |
cw_convert_opportunity_to_ticket |
Pro | Write | [ConnectWise] Convert a won sales opportunity into a service ticket. Creates a new service ticket based on the opportunity details. This is typically used to initiate service delivery after closing a deal. Requires a valid opportunity ID — use cw_list_opportunities to find IDs. Returns the conversion result. |
cw_count_opportunities |
Free | Read-only | [ConnectWise] Get a count of sales opportunities matching optional conditions. Returns the total number of matching opportunities without fetching data. Useful for pipeline dashboards, reporting, and checking result set size before paginating with cw_list_opportunities. |
cw_create_opportunity |
Pro | Write | [ConnectWise] Create a new sales opportunity. Requires at minimum a name. Call cw_discover_opportunity_types and cw_discover_opportunity_stages to find valid type and stage IDs. Returns the created opportunity with its assigned ID. |
cw_delete_opportunity |
Pro | Destructive | [ConnectWise] Permanently delete a sales opportunity by ID. This cannot be undone. Verify the opportunity with cw_get_opportunity before deleting. Requires a valid opportunity ID — use cw_list_opportunities to find IDs. |
cw_get_opportunity |
Free | Read-only | [ConnectWise] Retrieve a single sales opportunity by ID. Returns full opportunity details including name, status, stage, company, primary contact, expected revenue, probability, close date, and custom fields. Requires a valid opportunity ID — use cw_list_opportunities to find IDs. |
cw_list_company_opportunities |
Free | Read-only | [ConnectWise] List all sales opportunities for a specific company. A convenience tool that filters opportunities to a single company by ID. Useful for reviewing a client's sales history and active deals. |
cw_list_opportunities |
Free | Read-only | [ConnectWise] List sales opportunities with optional filtering and sorting. Returns paginated opportunity summaries including ID, name, status, stage, company, expected revenue, and close date. Use this to review the sales pipeline or narrow results before fetching full details with cw_get_opportunity. Call cw_discover_opportunity_statuses and cw_discover_opportunity_stages first to learn valid filter values. |
cw_list_won_opportunities |
Free | Read-only | [ConnectWise] List sales opportunities with status 'Won'. Useful for revenue tracking, sales performance reviews, and identifying deals that need to be converted to agreements or projects. |
cw_search_opportunities |
Free | Read-only | [ConnectWise] Search sales opportunities by name or company name. Returns matching opportunities ranked by relevance. Use this when looking for opportunities by keyword rather than structured filtering with cw_list_opportunities. |
cw_update_opportunity |
Pro | Write | [ConnectWise] Update an existing sales opportunity using JSON Patch operations. Requires a valid opportunity ID — use cw_list_opportunities to find IDs. Returns the updated opportunity. |
cw_convert_opportunity_to_sales_order parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
opportunityId |
integer | yes | The numeric ConnectWise opportunity ID to convert. |
cw_convert_opportunity_to_ticket parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
opportunityId |
integer | yes | The numeric ConnectWise opportunity ID to convert. |
cw_count_opportunities parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='New'", "member/identifier='jsmith'". Use '/' for nested fields. |
cw_create_opportunity parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Opportunity fields as JSON. Required: {"name": "..."}. Optional: status, stage, type, company, contact, primarySalesRep, expectedCloseDate, probability, expectedRevenue. Example: {"name": "Cloud Migration - Contoso", "company": {"id": 42}, "expectedCloseDate": "2024-06-30T00:00:00Z", "probability": {"id": 3}} |
cw_delete_opportunity parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise opportunity ID to delete. Verify with cw_get_opportunity before deleting. |
cw_get_opportunity parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise opportunity ID. |
cw_list_company_opportunities parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The numeric ConnectWise company ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_opportunities parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='New'", "member/identifier='jsmith'". Use '/' for nested fields. |
orderBy |
string | no | null | Sort order. Examples: "id desc", "closedDate asc". Use field names from the opportunity object. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_won_opportunities parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_search_opportunities parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
search |
string | yes | Search term to match against opportunity name or company name. |
cw_update_opportunity parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise opportunity ID to update. | |
patchJson |
string | yes | JSON array of patch operations. Example: [{"op": "replace", "path": "name", "value": "Updated Opportunity"}, {"op": "replace", "path": "stage", "value": {"id": 2}}] |
Opportunity Sub-Resources
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_convert_opportunity_to_agreement |
Pro | Write | [ConnectWise] Convert a won sales opportunity into an agreement. Creates a new agreement based on the opportunity details. This is typically used after a deal is closed/won to set up recurring billing. Requires a valid opportunity ID — use cw_list_opportunities to find IDs. Returns the conversion result. |
cw_convert_opportunity_to_project |
Pro | Write | [ConnectWise] Convert a won sales opportunity into a project. Creates a new project based on the opportunity details. This is typically used after a deal is closed/won to begin project delivery. Requires a valid opportunity ID — use cw_list_opportunities to find IDs. Returns the conversion result. |
cw_create_opportunity_contact |
Pro | Write | [ConnectWise] Link a contact to a sales opportunity. Associates an existing contact with this deal. Requires a valid opportunity ID and contact reference. Returns the created opportunity-contact association. |
cw_create_opportunity_note |
Pro | Write | [ConnectWise] Add a note to a sales opportunity. Use this to record sales conversations, decisions, or follow-up items. Requires a valid opportunity ID. Returns the created note with its assigned ID. |
cw_create_opportunity_team_member |
Pro | Write | [ConnectWise] Add a team member to a sales opportunity. Assigns a member with a specific sales role and optional commission percentage. Requires a valid opportunity ID. Call cw_discover_sales_roles to find valid role IDs. Returns the created team member assignment. |
cw_list_opportunity_contacts |
Free | Read-only | [ConnectWise] List contacts associated with a sales opportunity. Returns contact references linked to this deal, including contact ID, name, and role. Requires a valid opportunity ID — use cw_list_opportunities to find IDs. |
cw_list_opportunity_forecasts |
Free | Read-only | [ConnectWise] List forecast entries for a sales opportunity. Returns forecast data including revenue projections, probability, and close date estimates. Forecasts help predict revenue from the sales pipeline. Requires a valid opportunity ID — use cw_list_opportunities to find IDs. |
cw_list_opportunity_notes |
Free | Read-only | [ConnectWise] List notes attached to a sales opportunity. Returns note summaries including ID, text, type, and created date. Opportunity notes capture sales conversations, decisions, and follow-up items. Requires a valid opportunity ID — use cw_list_opportunities to find IDs. |
cw_list_opportunity_team |
Free | Read-only | [ConnectWise] List team members assigned to a sales opportunity. Returns team member references including member, role, and commission percentage. Use this to see who is working on a deal. Requires a valid opportunity ID — use cw_list_opportunities to find IDs. |
cw_convert_opportunity_to_agreement parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
opportunityId |
integer | yes | The numeric ConnectWise opportunity ID to convert. |
cw_convert_opportunity_to_project parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
opportunityId |
integer | yes | The numeric ConnectWise opportunity ID to convert. |
cw_create_opportunity_contact parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Contact association fields as JSON. Required: contact reference. Example: {"contact": {"id": 45}, "role": {"id": 1}} | |
opportunityId |
integer | yes | The numeric ConnectWise opportunity ID. |
cw_create_opportunity_note parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Note fields as JSON. Required: {"text": "..."}. Optional: type, flagged. Example: {"text": "Client interested in premium tier", "type": {"id": 1}} | |
opportunityId |
integer | yes | The numeric ConnectWise opportunity ID. |
cw_create_opportunity_team_member parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Team member fields as JSON. Required: member reference. Optional: salesRole, commissionPercent. Example: {"member": {"identifier": "jsmith"}, "salesRole": {"id": 1}, "commissionPercent": 50} | |
opportunityId |
integer | yes | The numeric ConnectWise opportunity ID. |
cw_list_opportunity_contacts parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
opportunityId |
integer | yes | The numeric ConnectWise opportunity ID. |
cw_list_opportunity_forecasts parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
opportunityId |
integer | yes | The numeric ConnectWise opportunity ID. |
cw_list_opportunity_notes parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
opportunityId |
integer | yes | The numeric ConnectWise opportunity ID. |
cw_list_opportunity_team parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
opportunityId |
integer | yes | The numeric ConnectWise opportunity ID. |
Sales Activities
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_count_activities |
Free | Read-only | [ConnectWise] Get a count of sales activities matching optional conditions. Returns a single-record result for counting. Useful for tracking activity volumes or checking result set size before paginating with cw_list_activities. |
cw_create_activity |
Pro | Write | [ConnectWise] Create a new sales activity. Activities track sales interactions such as calls, meetings, emails, and follow-ups. Returns the created activity with its assigned ID. |
cw_delete_activity |
Pro | Destructive | [ConnectWise] Permanently delete a sales activity by ID. This cannot be undone. Verify the activity with cw_get_activity before deleting. Requires a valid activity ID — use cw_list_activities to find IDs. |
cw_get_activity |
Free | Read-only | [ConnectWise] Retrieve a single sales activity by ID. Returns full activity details including name, type, status, assigned member, company, contact, opportunity, notes, and schedule info. Requires a valid activity ID — use cw_list_activities to find IDs. |
cw_list_activities |
Free | Read-only | [ConnectWise] List sales activities with optional filtering. Returns paginated activity summaries including ID, name, type, status, assigned member, company, and schedule info. Activities track sales interactions such as calls, meetings, emails, and follow-ups. |
cw_list_activity_stopwatches_by_member |
Free | Read-only | [ConnectWise] List activity stopwatches filtered by member identifier. Returns running or paused stopwatch records for activities. Use to find active timers associated with sales activities for a specific member. |
cw_search_activities |
Free | Read-only | [ConnectWise] Search sales activities by name or member identifier. Returns matching activities. Use this when you know the activity name or assigned member but not the numeric ID. |
cw_update_activity |
Pro | Write | [ConnectWise] Update an existing sales activity using JSON Patch operations. Requires a valid activity ID — use cw_list_activities to find IDs. Returns the updated activity. |
cw_count_activities parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='New'", "member/identifier='jsmith'". Use '/' for nested fields. |
cw_create_activity parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Activity fields as JSON. Required: {"name": "..."}. Optional: type, status, assignTo, company, contact, opportunity, notes, dateStart, dateEnd. Example: {"name": "Follow-up call with Contoso", "type": {"id": 1}, "company": {"id": 42}, "assignTo": {"identifier": "jsmith"}} |
cw_delete_activity parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise activity ID to delete. Verify with cw_get_activity before deleting. |
cw_get_activity parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise activity ID. |
cw_list_activities parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='New'", "member/identifier='jsmith'". Use '/' for nested fields. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_activity_stopwatches_by_member parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
memberIdentifier |
string | yes | Member identifier to filter by. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_search_activities parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
search |
string | yes | Search text to match against activity name or assigned member identifier. |
cw_update_activity parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise activity ID to update. | |
patchJson |
string | yes | JSON array of patch operations. Example: [{"op": "replace", "path": "name", "value": "Updated activity"}, {"op": "replace", "path": "status", "value": {"id": 2}}] |
Sales Orders
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_count_orders |
Free | Read-only | [ConnectWise] Get a count of sales orders matching optional conditions. Returns a single-record result for counting. Useful for sales pipeline dashboards. |
cw_create_order |
Pro | Write | [ConnectWise] Create a new sales order. Sales orders represent committed deals that are ready for fulfillment. Typically created by converting a won opportunity, but can also be created directly. Call cw_discover_order_statuses to find valid status IDs. Returns the created order with its assigned ID. |
cw_create_order_line_item |
Pro | Write | [ConnectWise] Add a line item to a sales order. Line items represent individual products or services being sold. Requires a valid sales order ID — use cw_list_orders to find IDs. Returns the created line item with its assigned ID. |
cw_get_order |
Free | Read-only | [ConnectWise] Retrieve a single sales order by ID. Returns full order details including description, company, opportunity, status, total, line items, and billing info. Requires a valid sales order ID — use cw_list_orders to find IDs. |
cw_list_order_line_items |
Free | Read-only | [ConnectWise] List line items for a specific sales order. Returns product/service entries including description, quantity, unit price, and total. Requires a valid sales order ID — use cw_list_orders to find IDs. |
cw_list_orders |
Free | Read-only | [ConnectWise] List sales orders with optional filtering. Returns paginated order summaries including ID, description, company, opportunity, status, and total. Sales orders represent committed deals from won opportunities. |
cw_search_orders |
Free | Read-only | [ConnectWise] Search sales orders by description or company name. Returns matching orders. Use this when you know the order description or company but not the numeric ID. |
cw_update_order |
Pro | Write | [ConnectWise] Update an existing sales order using JSON Patch operations. Requires a valid sales order ID — use cw_list_orders to find IDs. Returns the updated order. |
cw_count_orders parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='New'". Use '/' for nested fields. |
cw_create_order parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Sales order fields as JSON. Required: company reference. Optional: description, opportunity, status, contact, salesRep, notes. Example: {"company": {"id": 42}, "description": "Annual license renewal", "opportunity": {"id": 10}} |
cw_create_order_line_item parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Line item fields as JSON. Required: description or catalogItem reference. Optional: quantity, unitPrice, discount, taxableFlag. Example: {"catalogItem": {"id": 5}, "quantity": 10, "unitPrice": 99.99} | |
orderId |
integer | yes | The numeric ConnectWise sales order ID. |
cw_get_order parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise sales order ID. |
cw_list_order_line_items parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
orderId |
integer | yes | The numeric ConnectWise sales order ID. |
cw_list_orders parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='New'", "member/identifier='jsmith'". Use '/' for nested fields. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_search_orders parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
search |
string | yes | Search text to match against order description or company name. |
cw_update_order parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise sales order ID to update. | |
patchJson |
string | yes | JSON array of patch operations. Example: [{"op": "replace", "path": "description", "value": "Updated description"}, {"op": "replace", "path": "status", "value": {"id": 2}}] |
Sales Discovery
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_discover_activity_statuses |
Free | Read-only | [ConnectWise] List all available activity statuses. Statuses define the lifecycle of sales activities (e.g., Open, Completed, Cancelled). Use this to find valid status IDs when creating or filtering sales activities. |
cw_discover_activity_types |
Free | Read-only | [ConnectWise] List all available activity types. Activity types categorize sales activities (e.g., Phone Call, Email, Meeting, Demo). Use this to find valid type IDs when creating or filtering sales activities. |
cw_discover_opportunity_ratings |
Free | Read-only | [ConnectWise] List all available opportunity ratings. Ratings qualify the likelihood and quality of a deal (e.g., Hot, Warm, Cold). Use this to find valid rating IDs when creating or filtering opportunities. |
cw_discover_opportunity_stages |
Free | Read-only | [ConnectWise] List all available opportunity stages. Stages represent the sales process steps (e.g., Prospecting, Qualification, Proposal, Negotiation, Closed). Use this to find valid stage IDs when creating or filtering opportunities. |
cw_discover_opportunity_statuses |
Free | Read-only | [ConnectWise] List all available opportunity statuses. Statuses define the lifecycle of opportunities (e.g., Open, Won, Lost, Inactive). Use this to find valid status IDs when creating or filtering opportunities. |
cw_discover_opportunity_types |
Free | Read-only | [ConnectWise] List all available opportunity types. Opportunity types categorize deals (e.g., New Business, Renewal, Upsell). Use this to find valid type IDs when creating or filtering opportunities. |
cw_discover_order_statuses |
Free | Read-only | [ConnectWise] List all available sales order statuses. Statuses define the lifecycle of sales orders (e.g., New, In Progress, Closed). Use this to find valid status IDs when creating or filtering sales orders. |
cw_discover_sales_probabilities |
Free | Read-only | [ConnectWise] List all available sales probabilities. Probabilities represent the likelihood of closing a deal (e.g., 10%, 25%, 50%, 75%, 90%). Use this to find valid probability IDs when creating or filtering opportunities. |
cw_discover_sales_roles |
Free | Read-only | [ConnectWise] List all available sales roles. Sales roles define team member responsibilities on opportunities (e.g., Primary Rep, Secondary Rep, Engineer). Use this to find valid role IDs when adding team members to opportunities. |
Members
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_get_member |
Free | Read-only | [ConnectWise] Get member by numeric ID. Accepts member identifier. Returns full member details including name, email, role, department, and inactive status. Requires a valid member ID — use cw_list_members to find IDs. |
cw_get_system_info |
Free | Read-only | [ConnectWise] Retrieve ConnectWise system information including version and license info. Use to validate connectivity. |
cw_list_active_members |
Free | Read-only | [ConnectWise] List all active (non-inactive) members. A convenience filter that returns only members with inactiveFlag=false. Useful for quick team roster views or populating member dropdown lists. |
cw_list_certifications |
Free | Read-only | [ConnectWise] List all certification types configured in ConnectWise. Returns certification IDs and names. Use to discover available certification types before querying member-specific certifications with cw_list_member_certifications. |
cw_list_department_members |
Free | Read-only | [ConnectWise] List active members in a specific department. A convenience tool that filters members by department identifier. Useful for department-level staffing views and workload distribution. |
cw_list_departments |
Free | Read-only | [ConnectWise] List departments with optional filtering and pagination. Returns department IDs and names. Use these values when filtering members or other department-scoped data. |
cw_list_member_certifications |
Free | Read-only | [ConnectWise] List certifications held by a specific member. Returns certification records including name, number, and expiration date. Use to verify member qualifications or track certification renewals. |
cw_list_member_delegations |
Free | Read-only | [ConnectWise] List delegations for a specific member. Returns delegation records showing who a member has delegated responsibilities to, including date ranges and delegation types. Use for coverage planning and OOO management. |
cw_list_member_skills |
Free | Read-only | [ConnectWise] List skills assigned to a specific member. Returns skill records including skill name, level, and years of experience. Use to understand a member's technical capabilities for dispatch or project assignment. |
cw_list_members |
Free | Read-only | [ConnectWise] List members with optional filtering, sorting, and pagination. Returns member summaries including ID, identifier, name, email, and role. Use this to discover member IDs for filtering tickets, time entries, and other member-scoped data. |
cw_list_skills |
Free | Read-only | [ConnectWise] List all skills configured in ConnectWise. Returns skill IDs, names, and categories. Use to discover available skill types before querying member-specific skills with cw_list_member_skills. |
cw_search_members |
Free | Read-only | [ConnectWise] Search members by name or identifier. Returns matching members ranked by relevance. Use this when you know the member's name or login identifier but not the numeric ID. |
cw_get_member parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise member ID. |
cw_list_active_members parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_department_members parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
department |
string | yes | The department name or identifier to filter by (e.g., 'Engineering', 'Support'). | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_departments parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "name='Engineering'". Use '/' for nested fields. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_member_certifications parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
memberId |
integer | yes | The numeric ConnectWise member ID. Use cw_list_members to find valid IDs. |
cw_list_member_delegations parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
memberId |
integer | yes | The numeric ConnectWise member ID. Use cw_list_members to find valid IDs. |
cw_list_member_skills parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
memberId |
integer | yes | The numeric ConnectWise member ID. Use cw_list_members to find valid IDs. |
cw_list_members parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "inactiveFlag=false", "identifier='jsmith'". Use '/' for nested fields. |
orderBy |
string | no | null | Sort order. Examples: "identifier asc", "lastName desc". |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_search_members parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
search |
string | yes | Search text to match against member first name, last name, or identifier. |
Schedule
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_create_schedule_entry |
Pro | Write | [ConnectWise] Create a new schedule entry. Requires at minimum a member reference and date range. Returns the created schedule entry with its assigned ID. This creates data visible to dispatchers and technicians. |
cw_delete_schedule_entry |
Pro | Destructive | [ConnectWise] Permanently delete a schedule entry by ID. This cannot be undone. Verify the entry with cw_get_schedule_entry before deleting. Requires a valid schedule entry ID — use cw_list_schedule_entries to find IDs. |
cw_get_schedule_entry |
Free | Read-only | [ConnectWise] Retrieve a single schedule entry by ID. Returns full schedule entry details including member, type, date range, status, and associated ticket or activity. Requires a valid schedule entry ID — use cw_list_schedule_entries to find IDs. |
cw_list_calendars |
Free | Read-only | [ConnectWise] List calendars with optional filtering. Returns paginated calendar records including name, holiday list, and schedule details. Useful for discovering available calendars when creating or filtering schedule entries. |
cw_list_member_schedule |
Free | Read-only | [ConnectWise] List schedule entries for a specific member by identifier. A convenience tool that filters schedule entries to a single member. Use this to quickly see a technician's upcoming or recent schedule. |
cw_list_member_today_schedule |
Free | Read-only | [ConnectWise] List today's schedule entries for a specific member. Useful for daily planning and dispatch -- shows what a technician has scheduled for the current day. |
cw_list_schedule_entries |
Free | Read-only | [ConnectWise] List schedule entries with optional filtering and sorting. Returns paginated schedule entries including member, type, date range, and status. Use this to browse scheduled activities or narrow results before fetching full details with cw_get_schedule_entry. |
cw_list_upcoming_schedule |
Free | Read-only | [ConnectWise] List future schedule entries starting from today. Useful for dispatch planning and capacity views -- shows all upcoming scheduled work across the team. |
cw_update_schedule_entry |
Pro | Write | [ConnectWise] Update an existing schedule entry using JSON Patch operations. Requires a valid schedule entry ID — use cw_list_schedule_entries to find IDs. Returns the updated schedule entry. |
cw_create_schedule_entry parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Schedule entry fields as JSON. Required: {"member": {"identifier": "..."}, "dateStart": "...", "dateEnd": "..."}. Optional: type, span, objectId, status, reminder. |
cw_delete_schedule_entry parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise schedule entry ID to delete. Verify with cw_get_schedule_entry before deleting. |
cw_get_schedule_entry parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise schedule entry ID. |
cw_list_calendars parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "name='Default Calendar'". Use '/' for nested fields, 'and'/'or' for boolean logic. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_member_schedule parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
memberIdentifier |
string | yes | The ConnectWise member identifier (e.g., 'jsmith'). | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_member_today_schedule parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
memberIdentifier |
string | yes | The ConnectWise member identifier (e.g., 'jsmith'). | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_schedule_entries parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "member/identifier='jsmith'", "dateStart>=[2024-01-01T00:00:00Z]". Use '/' for nested fields, 'and'/'or' for boolean logic. |
orderBy |
string | no | null | Sort order. Examples: "dateStart desc", "id asc". Use field names from the schedule entry object. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_upcoming_schedule parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_update_schedule_entry parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise schedule entry ID to update. | |
patchJson |
string | yes | JSON array of patch operations. Example: [{"op": "replace", "path": "dateEnd", "value": "2024-06-15T17:00:00Z"}] |
Schedule Reference
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_discover_schedule_statuses |
Free | Read-only | [ConnectWise] List all schedule statuses configured in ConnectWise. Returns status IDs and names. Use to discover valid statuses when creating or filtering schedule entries. |
cw_discover_schedule_types |
Free | Read-only | [ConnectWise] List all schedule types configured in ConnectWise. Returns type IDs and names. Use to discover valid schedule types when creating or filtering schedule entries. |
cw_get_calendar |
Free | Read-only | [ConnectWise] Retrieve a single calendar by ID. Returns full calendar details including name, holiday list, and default schedule hours. Requires a valid calendar ID — use cw_list_calendars to find IDs. |
cw_list_holiday_lists |
Free | Read-only | [ConnectWise] List holiday lists with optional filtering. Returns paginated holiday list records including name and associated holidays. Use to discover configured holiday schedules that affect SLA calculations and scheduling. |
cw_list_holidays |
Free | Read-only | [ConnectWise] List holidays within a specific holiday list. Returns holiday records including name, date, and hours off. Use to see which dates are configured as holidays for a given holiday list. |
cw_list_schedule_entry_count |
Free | Read-only | [ConnectWise] Get a count of schedule entries matching optional conditions. Returns the total number of matching schedule entries. Useful for understanding schedule density or checking result set size before paginating with cw_list_schedule_entries. |
cw_search_schedule_entries |
Free | Read-only | [ConnectWise] Search schedule entries by member identifier. Returns matching schedule entries. Use this when you know the member but want to find their schedule entries. |
cw_get_calendar parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise calendar ID. |
cw_list_holiday_lists parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "name contains 'US'". Use '/' for nested fields, 'and'/'or' for boolean logic. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_holidays parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
holidayListId |
integer | yes | The numeric ConnectWise holiday list ID. Use cw_list_holiday_lists to find valid IDs. |
cw_list_schedule_entry_count parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "member/identifier='jsmith'", "dateStart>=[2024-01-01T00:00:00Z]". Use '/' for nested fields, 'and'/'or' for boolean logic. |
cw_search_schedule_entries parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
search |
string | yes | Search text to match against member identifier. |
Procurement
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_bulk_create_po_line_items |
Pro | Write | [ConnectWise] Create multiple PO line items in a single bulk request. Body is a JSON array of line items. |
cw_bulk_delete_po_line_items |
Pro | Destructive | [ConnectWise] Delete multiple PO line items in a single request. Body is a JSON array of line item IDs or line-item references. |
cw_bulk_replace_po_line_items |
Pro | Write | [ConnectWise] Replace multiple PO line items in a single bulk PUT request. |
cw_copy_catalog_item |
Pro | Write | [ConnectWise] Create a copy of a catalog item. Body is a copy-options payload (new identifier, description, etc.). |
cw_copy_purchase_order |
Pro | Write | [ConnectWise] Create a copy of a purchase order. Body is a copy-options payload. |
cw_count_adjustment_details |
Free | Read-only | [ConnectWise] Count detail lines on an adjustment. |
cw_count_adjustment_types |
Free | Read-only | [ConnectWise] Count adjustment types matching an optional conditions filter. |
cw_count_adjustment_types_info |
Free | Read-only | [ConnectWise] Count adjustment types at the info/count endpoint. |
cw_count_adjustments |
Free | Read-only | [ConnectWise] Count adjustments matching an optional conditions filter. |
cw_count_catalog_components |
Free | Read-only | [ConnectWise] Count components on a catalog bundle, optionally filtered by conditions. |
cw_count_catalog_inventory |
Free | Read-only | [ConnectWise] Count inventory rows on a catalog item, optionally filtered by conditions. Returns the CW count payload. |
cw_count_catalog_items |
Free | Read-only | [ConnectWise] Get a count of catalog items matching optional conditions. Returns a single-record result for counting. Useful for checking result set size before paginating with cw_list_catalog_items. |
cw_count_catalog_items_endpoint |
Free | Read-only | [ConnectWise] Call the dedicated /procurement/catalog/count endpoint. This is distinct from cw_count_catalog_items, which uses a list query with pageSize=1. |
cw_count_catalog_items_info |
Free | Read-only | [ConnectWise] Count catalog items at the /procurement/catalog/info/count endpoint. |
cw_count_catalog_min_stock |
Free | Read-only | [ConnectWise] Count minimum-stock rows on a catalog item, optionally filtered by conditions. |
cw_count_change_orders |
Free | Read-only | [ConnectWise] Count change orders. Note: swagger exposes count at the plural /procurement/changeorders/count path. |
cw_count_directional_syncs |
Free | Read-only | [ConnectWise] Count directional syncs. |
cw_count_invoice_groupings |
Free | Read-only | [ConnectWise] Count invoice groupings. |
cw_count_manufacturers |
Free | Read-only | [ConnectWise] Count manufacturers matching an optional conditions filter. |
cw_count_manufacturers_info |
Free | Read-only | [ConnectWise] Count manufacturers at CW's /procurement/manufacturers/count/info endpoint. Swagger spells this differently than other count/info endpoints (no plain /info/count variant). |
cw_count_onhand_serials |
Free | Read-only | [ConnectWise] Count on-hand serial numbers matching an optional conditions filter. |
cw_count_po_line_items |
Free | Read-only | [ConnectWise] Count line items on a purchase order, optionally filtered. |
cw_count_po_notes |
Free | Read-only | [ConnectWise] Count notes on a purchase order, optionally filtered. |
cw_count_po_quick_access |
Free | Read-only | [ConnectWise] Retrieve the quick-access count for a purchase order. Returns CW's /quickAccess/count payload. |
cw_count_po_status_email_templates |
Free | Read-only | [ConnectWise] Count email templates on a PO status. |
cw_count_po_status_notifications |
Free | Read-only | [ConnectWise] Count notifications on a PO status. |
cw_count_po_statuses |
Free | Read-only | [ConnectWise] Count PO statuses matching an optional conditions filter. |
cw_count_po_statuses_info |
Free | Read-only | [ConnectWise] Count PO statuses at the CW capital-I /Info/count endpoint. |
cw_count_pricing_schedule_breaks |
Free | Read-only | [ConnectWise] Count quantity-break rules on a pricing schedule detail. |
cw_count_pricing_schedule_details |
Free | Read-only | [ConnectWise] Count detail rows on a pricing schedule. |
cw_count_pricing_schedules |
Free | Read-only | [ConnectWise] Count pricing schedules matching an optional conditions filter. |
cw_count_procurement_categories |
Free | Read-only | [ConnectWise] Count procurement categories matching an optional conditions filter. |
cw_count_procurement_categories_info |
Free | Read-only | [ConnectWise] Count procurement categories at the info/count endpoint. |
cw_count_procurement_settings |
Free | Read-only | [ConnectWise] Count procurement settings. |
cw_count_procurement_subcategories_for_category |
Free | Read-only | [ConnectWise] Count nested subcategories under a category, optionally filtered. |
cw_count_procurement_subcategories_for_category_info |
Free | Read-only | [ConnectWise] Count nested subcategories at the info/count endpoint. |
cw_count_product_components |
Free | Read-only | [ConnectWise] Count components on a procurement product, optionally filtered. |
cw_count_product_picking_shipping |
Free | Read-only | [ConnectWise] Count picking/shipping detail rows on a procurement product. |
cw_count_product_types |
Free | Read-only | [ConnectWise] Count product types matching an optional conditions filter. |
cw_count_product_types_info |
Free | Read-only | [ConnectWise] Count product types at the info/count endpoint. |
cw_count_products |
Free | Read-only | [ConnectWise] Count procurement products matching an optional conditions filter. |
cw_count_purchase_orders |
Free | Read-only | [ConnectWise] Get a count of purchase orders matching optional conditions. Returns a single-record result for counting. Useful for checking result set size before paginating with cw_list_purchase_orders. |
cw_count_purchase_orders_endpoint |
Free | Read-only | [ConnectWise] Call the dedicated /procurement/purchaseorders/count endpoint. Distinct from cw_count_purchase_orders (which is a list with pageSize=1). |
cw_count_purchase_orders_info |
Free | Read-only | [ConnectWise] Count purchase orders at the /procurement/purchaseorders/info/count endpoint. |
cw_count_rma_actions |
Free | Read-only | [ConnectWise] Count RMA actions matching an optional conditions filter. |
cw_count_rma_actions_info |
Free | Read-only | [ConnectWise] Count RMA actions at the /procurement/rmaActions/info/count endpoint. |
cw_count_rma_dispositions |
Free | Read-only | [ConnectWise] Count RMA dispositions matching an optional conditions filter. |
cw_count_rma_dispositions_info |
Free | Read-only | [ConnectWise] Count RMA dispositions at the info/count endpoint. |
cw_count_rma_status_email_templates |
Free | Read-only | [ConnectWise] Count email templates on an RMA status, optionally filtered. |
cw_count_rma_status_notifications |
Free | Read-only | [ConnectWise] Count notifications on an RMA status. |
cw_count_rma_statuses |
Free | Read-only | [ConnectWise] Count RMA statuses matching an optional conditions filter. |
cw_count_rma_statuses_info |
Free | Read-only | [ConnectWise] Count RMA statuses at the info/count endpoint. |
cw_count_rma_tags |
Free | Read-only | [ConnectWise] Count RMA tags matching an optional conditions filter. |
cw_count_shipment_methods |
Free | Read-only | [ConnectWise] Count shipment methods matching an optional conditions filter. |
cw_count_shipment_methods_info |
Free | Read-only | [ConnectWise] Count shipment methods at the info/count endpoint. |
cw_count_subcategories |
Free | Read-only | [ConnectWise] Count top-level subcategories matching an optional conditions filter. |
cw_count_subcategories_info |
Free | Read-only | [ConnectWise] Count top-level subcategories at the info/count endpoint. |
cw_count_unit_of_measures |
Free | Read-only | [ConnectWise] Count units of measure matching an optional conditions filter. |
cw_count_uom_conversions |
Free | Read-only | [ConnectWise] Count UoM conversions on a unit of measure. |
cw_count_warehouse_bin_inventory |
Free | Read-only | [ConnectWise] Count inventory-on-hand rows in a bin, optionally filtered. |
cw_count_warehouse_bins |
Free | Read-only | [ConnectWise] Count warehouse bins matching an optional conditions filter. |
cw_count_warehouse_bins_info |
Free | Read-only | [ConnectWise] Count warehouse bins at the /procurement/warehouseBins/info/count endpoint. |
cw_count_warehouses |
Free | Read-only | [ConnectWise] Count warehouses matching an optional conditions filter. |
cw_count_warehouses_info |
Free | Read-only | [ConnectWise] Count warehouses at the /procurement/warehouses/info/count endpoint. |
cw_create_adjustment |
Pro | Write | [ConnectWise] Create a new inventory adjustment. |
cw_create_adjustment_detail |
Pro | Write | [ConnectWise] Add a detail line to an adjustment. |
cw_create_adjustment_type |
Pro | Write | [ConnectWise] Create a new adjustment type. |
cw_create_catalog_component |
Pro | Write | [ConnectWise] Add a component to a catalog bundle. Returns the created component with its assigned ID. |
cw_create_catalog_item |
Pro | Write | [ConnectWise] Create a new product catalog item. Requires at minimum an identifier and description. Returns the created catalog item with its assigned ID. This adds a new product to the catalog visible to procurement staff. |
cw_create_catalog_min_stock |
Pro | Write | [ConnectWise] Create a minimum-stock threshold for a catalog item in a specific warehouse. |
cw_create_catalog_vendor_link |
Pro | Write | [ConnectWise] Create a catalog-item-to-vendor association. Body shape is a vendor-link payload defined by CW. |
cw_create_change_order |
Pro | Write | [ConnectWise] Create a new procurement change order. |
cw_create_directional_sync |
Pro | Write | [ConnectWise] Create a new directional sync configuration. |
cw_create_manufacturer |
Pro | Write | [ConnectWise] Create a new manufacturer. |
cw_create_po_line_item |
Pro | Write | [ConnectWise] Add a line item to an existing purchase order. Requires a valid purchase order ID and product information. Returns the created line item with its assigned ID. |
cw_create_po_note |
Pro | Write | [ConnectWise] Add a note to a purchase order. |
cw_create_po_status |
Pro | Write | [ConnectWise] Create a new PO status. |
cw_create_po_status_email_template |
Pro | Write | [ConnectWise] Attach a new email template to a PO status. |
cw_create_po_status_notification |
Pro | Write | [ConnectWise] Create a notification configuration on a PO status. |
cw_create_pricing_schedule |
Pro | Write | [ConnectWise] Create a new pricing schedule. |
cw_create_pricing_schedule_break |
Pro | Write | [ConnectWise] Add a quantity-break rule to a pricing schedule detail. |
cw_create_pricing_schedule_detail |
Pro | Write | [ConnectWise] Add a detail rule to a pricing schedule. |
cw_create_procurement_category |
Pro | Write | [ConnectWise] Create a new procurement category. |
cw_create_procurement_subcategory_for_category |
Pro | Write | [ConnectWise] Create a subcategory nested under a procurement category. |
cw_create_product |
Pro | Write | [ConnectWise] Create a procurement product attached to a ticket, project, opportunity, or sales order. |
cw_create_product_component |
Pro | Write | [ConnectWise] Add a component to a procurement product bundle. |
cw_create_product_picking_shipping |
Pro | Write | [ConnectWise] Record a picking/shipping detail event for a procurement product. |
cw_create_product_type |
Pro | Write | [ConnectWise] Create a new product type. |
cw_create_purchase_order |
Pro | Write | [ConnectWise] Create a new purchase order. Requires at minimum a vendor reference. Returns the created purchase order with its assigned ID and PO number. This creates a PO visible to procurement staff. |
cw_create_purchasing_demand |
Pro | Write | [ConnectWise] Submit a purchasing demand. CW exposes only POST at /procurement/purchasingDemands -- there is no GET/list/delete. |
cw_create_rma_action |
Pro | Write | [ConnectWise] Create a new RMA action. |
cw_create_rma_disposition |
Pro | Write | [ConnectWise] Create a new RMA disposition. |
cw_create_rma_status |
Pro | Write | [ConnectWise] Create a new RMA status. |
cw_create_rma_status_email_template |
Pro | Write | [ConnectWise] Attach a new email template to an RMA status. |
cw_create_rma_status_notification |
Pro | Write | [ConnectWise] Create a notification configuration on an RMA status. |
cw_create_rma_tag |
Pro | Write | [ConnectWise] Create a new RMA tag. |
cw_create_shipment_method |
Pro | Write | [ConnectWise] Create a new shipment method. |
cw_create_subcategory |
Pro | Write | [ConnectWise] Create a new top-level subcategory. |
cw_create_unit_of_measure |
Pro | Write | [ConnectWise] Create a new unit of measure. |
cw_create_uom_conversion |
Pro | Write | [ConnectWise] Create a new UoM conversion. |
cw_create_warehouse |
Pro | Write | [ConnectWise] Create a new warehouse. Returns the created warehouse with its assigned ID. |
cw_create_warehouse_bin |
Pro | Write | [ConnectWise] Create a new warehouse bin. Requires a warehouse reference. |
cw_delete_adjustment |
Pro | Destructive | [ConnectWise] Permanently delete an inventory adjustment. |
cw_delete_adjustment_detail |
Pro | Destructive | [ConnectWise] Permanently delete an adjustment detail line. |
cw_delete_adjustment_type |
Pro | Destructive | [ConnectWise] Permanently delete an adjustment type. |
cw_delete_catalog_component |
Pro | Destructive | [ConnectWise] Permanently remove a component from a catalog bundle. This cannot be undone. |
cw_delete_catalog_item |
Pro | Destructive | [ConnectWise] Permanently delete a catalog item by ID. This cannot be undone. Verify the item with cw_get_catalog_item before deleting. Requires a valid catalog item ID. |
cw_delete_catalog_min_stock |
Pro | Destructive | [ConnectWise] Remove a minimum-stock threshold. This cannot be undone. |
cw_delete_catalog_vendor |
Pro | Destructive | [ConnectWise] Remove a vendor link from a catalog item. This cannot be undone. |
cw_delete_change_order |
Pro | Destructive | [ConnectWise] Permanently delete a change order. |
cw_delete_directional_sync |
Pro | Destructive | [ConnectWise] Permanently delete a directional sync. |
cw_delete_invoice_grouping |
Pro | Destructive | [ConnectWise] Permanently delete an invoice grouping. |
cw_delete_manufacturer |
Pro | Destructive | [ConnectWise] Permanently delete a manufacturer. |
cw_delete_po_line_items |
Pro | Destructive | [ConnectWise] Delete line items on a purchase order filtered by conditions. Without conditions, CW deletes all line items on the PO. |
cw_delete_po_note |
Pro | Destructive | [ConnectWise] Permanently delete a PO note. |
cw_delete_po_status |
Pro | Destructive | [ConnectWise] Permanently delete a PO status. |
cw_delete_po_status_email_template |
Pro | Destructive | [ConnectWise] Permanently remove an email template from a PO status. |
cw_delete_po_status_notification |
Pro | Destructive | [ConnectWise] Permanently delete a PO status notification. |
cw_delete_pricing_schedule |
Pro | Destructive | [ConnectWise] Permanently delete a pricing schedule. |
cw_delete_pricing_schedule_break |
Pro | Destructive | [ConnectWise] Permanently delete a pricing schedule break. |
cw_delete_pricing_schedule_detail |
Pro | Destructive | [ConnectWise] Permanently delete a pricing schedule detail. |
cw_delete_procurement_category |
Pro | Destructive | [ConnectWise] Permanently delete a procurement category. |
cw_delete_procurement_subcategory_for_category |
Pro | Destructive | [ConnectWise] Permanently delete a nested subcategory under a category. |
cw_delete_product |
Pro | Destructive | [ConnectWise] Permanently delete a procurement product. This cannot be undone. |
cw_delete_product_component |
Pro | Destructive | [ConnectWise] Permanently remove a component from a product bundle. |
cw_delete_product_picking_shipping |
Pro | Destructive | [ConnectWise] Permanently delete a picking/shipping detail record. |
cw_delete_product_type |
Pro | Destructive | [ConnectWise] Permanently delete a product type. |
cw_delete_purchase_order |
Pro | Destructive | [ConnectWise] Permanently delete a purchase order by ID. This cannot be undone. Verify the PO with cw_get_purchase_order before deleting. Requires a valid purchase order ID. |
cw_delete_rma_action |
Pro | Destructive | [ConnectWise] Permanently delete an RMA action. |
cw_delete_rma_disposition |
Pro | Destructive | [ConnectWise] Permanently delete an RMA disposition. |
cw_delete_rma_status |
Pro | Destructive | [ConnectWise] Permanently delete an RMA status. |
cw_delete_rma_status_email_template |
Pro | Destructive | [ConnectWise] Permanently remove an email template from an RMA status. |
cw_delete_rma_status_notification |
Pro | Destructive | [ConnectWise] Permanently delete an RMA status notification. |
cw_delete_rma_tag |
Pro | Destructive | [ConnectWise] Permanently delete an RMA tag. |
cw_delete_shipment_method |
Pro | Destructive | [ConnectWise] Permanently delete a shipment method. |
cw_delete_subcategory |
Pro | Destructive | [ConnectWise] Permanently delete a top-level subcategory. |
cw_delete_unit_of_measure |
Pro | Destructive | [ConnectWise] Permanently delete a unit of measure. |
cw_delete_uom_conversion |
Pro | Destructive | [ConnectWise] Permanently delete a UoM conversion. |
cw_delete_warehouse |
Pro | Destructive | [ConnectWise] Permanently delete a warehouse. This cannot be undone. Verify with cw_get_warehouse first. |
cw_delete_warehouse_bin |
Pro | Destructive | [ConnectWise] Permanently delete a warehouse bin. This cannot be undone. |
cw_detach_product |
Pro | Write | [ConnectWise] Detach a product from its current charge-to entity (ticket/project/etc) without deleting the product record. |
cw_discover_manufacturers |
Free | Read-only | [ConnectWise] List all manufacturers configured in ConnectWise. Returns manufacturer IDs and names. Use to discover valid manufacturers when creating or filtering catalog items. |
cw_discover_po_statuses |
Free | Read-only | [ConnectWise] List all purchase order statuses configured in ConnectWise. Returns status IDs and names. Use to discover valid statuses when creating or filtering purchase orders. |
cw_discover_procurement_categories |
Free | Read-only | [ConnectWise] List all procurement categories configured in ConnectWise. Returns category IDs and names. Use to discover valid categories when creating or filtering catalog items. |
cw_discover_procurement_subcategories |
Free | Read-only | [ConnectWise] List procurement subcategories for a specific category. Returns subcategory IDs and names. Requires a valid procurement category ID — use cw_discover_procurement_categories to find IDs. |
cw_discover_product_types |
Free | Read-only | [ConnectWise] List all product types configured in ConnectWise. Returns type IDs and names. Use to discover valid product types when creating or filtering catalog items. |
cw_discover_shipment_methods |
Free | Read-only | [ConnectWise] List all shipment methods configured in ConnectWise. Returns method IDs and names. Use to discover valid shipping methods when creating purchase orders. |
cw_discover_unit_of_measures |
Free | Read-only | [ConnectWise] List all units of measure configured in ConnectWise. Returns unit IDs and names (e.g., Each, Hour, Pack). Use to discover valid units when creating or updating catalog items. |
cw_discover_warehouses |
Free | Read-only | [ConnectWise] List all warehouses configured in ConnectWise. Returns warehouse IDs, names, and locations. Use to discover valid warehouses when creating purchase orders or managing inventory. |
cw_get_adjustment |
Free | Read-only | [ConnectWise] Retrieve a single inventory adjustment by ID. |
cw_get_adjustment_detail |
Free | Read-only | [ConnectWise] Retrieve a single adjustment detail line item by ID. |
cw_get_adjustment_type |
Free | Read-only | [ConnectWise] Retrieve a single adjustment type by ID. |
cw_get_adjustment_type_info |
Free | Read-only | [ConnectWise] Retrieve the compact 'info' projection of an adjustment type. |
cw_get_adjustment_type_usages |
Free | Read-only | [ConnectWise] Retrieve usage locations for an adjustment type. |
cw_get_catalog_component |
Free | Read-only | [ConnectWise] Retrieve a single component on a catalog bundle item by ID. |
cw_get_catalog_inventory |
Free | Read-only | [ConnectWise] Retrieve a single inventory record on a catalog item. Returns the per-warehouse inventory detail. Requires valid catalog item and inventory IDs. |
cw_get_catalog_item |
Free | Read-only | [ConnectWise] Retrieve a single catalog item by ID. Returns full catalog item details including identifier, description, category, subcategory, type, cost, price, vendor, and manufacturer info. Requires a valid catalog item ID — use cw_list_catalog_items to find IDs. |
cw_get_catalog_item_info |
Free | Read-only | [ConnectWise] Retrieve the compact 'info' projection of a catalog item (reduced payload, suitable for selectors). |
cw_get_catalog_min_stock |
Free | Read-only | [ConnectWise] Retrieve a single minimum-stock threshold record for a catalog item by its ID. |
cw_get_catalog_quantity_on_hand |
Free | Read-only | [ConnectWise] Retrieve the total quantity-on-hand for a catalog item by its string identifier (SKU), not numeric ID. Use this for quick stock lookups when you know the SKU. |
cw_get_directional_sync |
Free | Read-only | [ConnectWise] Retrieve a single directional sync configuration. |
cw_get_invoice_grouping |
Free | Read-only | [ConnectWise] Retrieve a single invoice grouping by ID. |
cw_get_invoice_grouping_usages |
Free | Read-only | [ConnectWise] Retrieve usage locations for an invoice grouping. |
cw_get_manufacturer |
Free | Read-only | [ConnectWise] Retrieve a single manufacturer by ID. |
cw_get_manufacturer_info |
Free | Read-only | [ConnectWise] Retrieve the compact 'info' projection of a manufacturer. |
cw_get_onhand_serial |
Free | Read-only | [ConnectWise] Retrieve a single on-hand serial number record. |
cw_get_po_line_item |
Free | Read-only | [ConnectWise] Retrieve a single purchase order line item by ID. |
cw_get_po_note |
Free | Read-only | [ConnectWise] Retrieve a single PO note by ID. |
cw_get_po_status |
Free | Read-only | [ConnectWise] Retrieve a single PO status by ID. |
cw_get_po_status_email_template |
Free | Read-only | [ConnectWise] Retrieve a single email template attached to a PO status. |
cw_get_po_status_info |
Free | Read-only | [ConnectWise] Retrieve the compact 'info' projection of a PO status. |
cw_get_po_status_notification |
Free | Read-only | [ConnectWise] Retrieve a single notification on a PO status. |
cw_get_po_status_usages |
Free | Read-only | [ConnectWise] Retrieve usage locations for a PO status. |
cw_get_pricing_schedule |
Free | Read-only | [ConnectWise] Retrieve a single pricing schedule by ID. |
cw_get_pricing_schedule_break |
Free | Read-only | [ConnectWise] Retrieve a single pricing schedule break. |
cw_get_pricing_schedule_detail |
Free | Read-only | [ConnectWise] Retrieve a single pricing schedule detail. |
cw_get_procurement_category |
Free | Read-only | [ConnectWise] Retrieve a single procurement category by ID. |
cw_get_procurement_category_info |
Free | Read-only | [ConnectWise] Retrieve the compact 'info' projection of a procurement category. |
cw_get_procurement_setting |
Free | Read-only | [ConnectWise] Retrieve a single procurement setting by ID. |
cw_get_procurement_subcategory_for_category |
Free | Read-only | [ConnectWise] Retrieve a nested subcategory under a procurement category. |
cw_get_procurement_subcategory_for_category_info |
Free | Read-only | [ConnectWise] Retrieve the compact 'info' projection of a nested subcategory. |
cw_get_product |
Free | Read-only | [ConnectWise] Retrieve a single procurement product by ID. |
cw_get_product_component |
Free | Read-only | [ConnectWise] Retrieve a single component on a procurement product bundle. |
cw_get_product_picking_shipping |
Free | Read-only | [ConnectWise] Retrieve a single picking/shipping detail on a procurement product. |
cw_get_product_type |
Free | Read-only | [ConnectWise] Retrieve a single product type by ID. |
cw_get_product_type_info |
Free | Read-only | [ConnectWise] Retrieve the compact 'info' projection of a product type. |
cw_get_product_type_usages |
Free | Read-only | [ConnectWise] Retrieve usage locations for a product type. |
cw_get_purchase_order |
Free | Read-only | [ConnectWise] Retrieve a single purchase order by ID. Returns full purchase order details including PO number, vendor, status, line items, shipping info, total, and dates. Requires a valid purchase order ID — use cw_list_purchase_orders to find IDs. |
cw_get_purchase_order_info |
Free | Read-only | [ConnectWise] Retrieve the compact 'info' projection of a purchase order. |
cw_get_rma_action |
Free | Read-only | [ConnectWise] Retrieve a single RMA action by ID. |
cw_get_rma_action_info |
Free | Read-only | [ConnectWise] Retrieve the compact 'info' projection of an RMA action. |
cw_get_rma_disposition |
Free | Read-only | [ConnectWise] Retrieve a single RMA disposition by ID. |
cw_get_rma_disposition_info |
Free | Read-only | [ConnectWise] Retrieve the compact 'info' projection of an RMA disposition. |
cw_get_rma_status |
Free | Read-only | [ConnectWise] Retrieve a single RMA status by ID. |
cw_get_rma_status_email_template |
Free | Read-only | [ConnectWise] Retrieve a single email template on an RMA status. |
cw_get_rma_status_info |
Free | Read-only | [ConnectWise] Retrieve the compact 'info' projection of an RMA status. |
cw_get_rma_status_notification |
Free | Read-only | [ConnectWise] Retrieve a single notification on an RMA status. |
cw_get_rma_status_usages |
Free | Read-only | [ConnectWise] Retrieve usage locations for an RMA status -- where in CW this status is currently referenced. |
cw_get_rma_tag |
Free | Read-only | [ConnectWise] Retrieve a single RMA tag by ID. |
cw_get_rma_tag_default |
Free | Read-only | [ConnectWise] Retrieve the default RMA tag configuration. |
cw_get_shipment_method |
Free | Read-only | [ConnectWise] Retrieve a single shipment method by ID. |
cw_get_shipment_method_info |
Free | Read-only | [ConnectWise] Retrieve the compact 'info' projection of a shipment method. |
cw_get_shipment_method_usages |
Free | Read-only | [ConnectWise] Retrieve usage locations for a shipment method. |
cw_get_subcategory |
Free | Read-only | [ConnectWise] Retrieve a single top-level subcategory by ID. |
cw_get_subcategory_info |
Free | Read-only | [ConnectWise] Retrieve the compact 'info' projection of a top-level subcategory. |
cw_get_subcategory_usages |
Free | Read-only | [ConnectWise] Retrieve usage locations for a top-level subcategory. |
cw_get_unit_of_measure |
Free | Read-only | [ConnectWise] Retrieve a single unit of measure by ID. |
cw_get_uom_conversion |
Free | Read-only | [ConnectWise] Retrieve a single UoM conversion by ID. |
cw_get_warehouse |
Free | Read-only | [ConnectWise] Retrieve a single warehouse by ID. Returns warehouse name, location, default flag, and inactive status. |
cw_get_warehouse_bin |
Free | Read-only | [ConnectWise] Retrieve a single warehouse bin by ID. |
cw_get_warehouse_bin_info |
Free | Read-only | [ConnectWise] Retrieve the compact 'info' projection of a warehouse bin. |
cw_get_warehouse_bin_inventory |
Free | Read-only | [ConnectWise] Retrieve a specific inventory-on-hand record in a bin by ID. |
cw_get_warehouse_info |
Free | Read-only | [ConnectWise] Retrieve the compact 'info' projection of a warehouse (reduced payload for selectors). |
cw_list_adjustment_details |
Free | Read-only | [ConnectWise] List detail line items on an adjustment (per-item deltas). |
cw_list_adjustment_type_usages |
Free | Read-only | [ConnectWise] Retrieve a detailed list of adjustment type usages via /usages/list. |
cw_list_adjustment_types |
Free | Read-only | [ConnectWise] List configurable adjustment types (e.g., 'Physical Count', 'Damage Write-Off'). |
cw_list_adjustment_types_info |
Free | Read-only | [ConnectWise] List adjustment types using the compact 'info' projection. |
cw_list_adjustments |
Free | Read-only | [ConnectWise] List inventory adjustments. Returns adjustment records used to correct on-hand stock counts. |
cw_list_catalog_components |
Free | Read-only | [ConnectWise] List bundled components for a catalog bundle item. Returns sub-item references, quantities, and pricing roll-up flags. Requires a valid catalog item ID. |
cw_list_catalog_inventory |
Free | Read-only | [ConnectWise] List inventory rows for a catalog item. Returns per-warehouse on-hand, allocated, and on-order quantities. Requires a valid catalog item ID -- use cw_list_catalog_items to find IDs. |
cw_list_catalog_items |
Free | Read-only | [ConnectWise] List product catalog items with optional filtering. Returns paginated catalog entries including identifier, description, category, cost, and price. Use this to browse the product catalog or narrow results before fetching full details with cw_get_catalog_item. |
cw_list_catalog_items_info |
Free | Read-only | [ConnectWise] List catalog items using the compact 'info' projection. Smaller payload; good for pickers and bulk scans. |
cw_list_catalog_min_stock |
Free | Read-only | [ConnectWise] List minimum-stock thresholds per warehouse for a catalog item. Returns the reorder thresholds used for automatic replenishment. |
cw_list_catalog_vendors |
Free | Read-only | [ConnectWise] List the vendors associated with a catalog item. CW exposes this via /procurement/catalog/vendors/. |
cw_list_change_orders |
Free | Read-only | [ConnectWise] List procurement change orders. Note: swagger exposes this at the singular /procurement/changeorder path. |
cw_list_directional_syncs |
Free | Read-only | [ConnectWise] List directional sync configurations (data flow rules to/from external systems). |
cw_list_invoice_grouping_usages |
Free | Read-only | [ConnectWise] Retrieve a detailed list of invoice grouping usages via /usages/list. |
cw_list_invoice_groupings |
Free | Read-only | [ConnectWise] List invoice grouping configurations (rules for grouping items on invoices). |
cw_list_manufacturers_info |
Free | Read-only | [ConnectWise] List manufacturers using the compact 'info' projection. |
cw_list_onhand_serials |
Free | Read-only | [ConnectWise] List serial numbers currently on hand across warehouses. Read-only; use adjustments or sales processes to move them. |
cw_list_open_purchase_orders |
Free | Read-only | [ConnectWise] List purchase orders with open or pending status. Useful for procurement tracking -- shows POs that are still being processed or awaiting delivery. |
cw_list_po_line_items |
Free | Read-only | [ConnectWise] List line items for a specific purchase order. Returns line item records including product, description, quantity, cost, and received status. Requires a valid purchase order ID — use cw_list_purchase_orders to find IDs. |
cw_list_po_notes |
Free | Read-only | [ConnectWise] List notes attached to a purchase order. |
cw_list_po_status_email_templates |
Free | Read-only | [ConnectWise] List email templates attached to a PO status. |
cw_list_po_status_notifications |
Free | Read-only | [ConnectWise] List notification configurations attached to a PO status. |
cw_list_po_status_usages |
Free | Read-only | [ConnectWise] Retrieve a detailed list of PO status usages via /usages/list. |
cw_list_po_statuses_info |
Free | Read-only | [ConnectWise] List PO statuses using the compact 'info' projection. |
cw_list_pricing_schedule_breaks |
Free | Read-only | [ConnectWise] List quantity-break rules on a pricing schedule detail (volume discount tiers). |
cw_list_pricing_schedule_details |
Free | Read-only | [ConnectWise] List detail rows on a pricing schedule (per-item or per-category rules). |
cw_list_pricing_schedules |
Free | Read-only | [ConnectWise] List pricing schedules. Pricing schedules define tiered pricing rules that apply across catalog items. |
cw_list_procurement_categories_info |
Free | Read-only | [ConnectWise] List procurement categories using the compact 'info' projection. |
cw_list_procurement_settings |
Free | Read-only | [ConnectWise] List system-level procurement settings. |
cw_list_procurement_subcategories_for_category_info |
Free | Read-only | [ConnectWise] List nested subcategories under a category using the compact 'info' projection. |
cw_list_product_components |
Free | Read-only | [ConnectWise] List bundled components on a procurement product instance. |
cw_list_product_picking_shipping |
Free | Read-only | [ConnectWise] List picking and shipping detail records on a procurement product. Tracks serial numbers, quantities picked, and shipping info. |
cw_list_product_type_usages |
Free | Read-only | [ConnectWise] Retrieve a detailed list of product type usages via /usages/list. |
cw_list_product_types_info |
Free | Read-only | [ConnectWise] List product types using the compact 'info' projection. |
cw_list_products |
Free | Read-only | [ConnectWise] List procurement products. These are catalog-item instances attached to tickets, projects, opportunities, or sales orders. Distinct from catalog items. |
cw_list_purchase_orders |
Free | Read-only | [ConnectWise] List purchase orders with optional filtering. Returns paginated purchase orders including PO number, vendor, status, total, and dates. Use this to browse purchase orders or narrow results before fetching full details with cw_get_purchase_order. |
cw_list_purchase_orders_info |
Free | Read-only | [ConnectWise] List purchase orders using the compact 'info' projection. |
cw_list_rma_actions |
Free | Read-only | [ConnectWise] List RMA actions (e.g., 'Return for Refund', 'Repair and Return'). Configures how returned products flow through the RMA process. |
cw_list_rma_actions_info |
Free | Read-only | [ConnectWise] List RMA actions using the compact 'info' projection. |
cw_list_rma_dispositions |
Free | Read-only | [ConnectWise] List RMA dispositions (final outcomes such as 'Scrap', 'Return to Stock'). Uses CW's ALL-CAPS /procurement/RMADispositions path. |
cw_list_rma_dispositions_info |
Free | Read-only | [ConnectWise] List RMA dispositions using the compact 'info' projection. |
cw_list_rma_status_email_templates |
Free | Read-only | [ConnectWise] List email templates attached to an RMA status. Per CW swagger, list uses the capital-T `emailTemplates` path. |
cw_list_rma_status_notifications |
Free | Read-only | [ConnectWise] List notification configurations attached to an RMA status. |
cw_list_rma_status_usages |
Free | Read-only | [ConnectWise] Retrieve a detailed list of RMA status usages via /usages/list. |
cw_list_rma_statuses |
Free | Read-only | [ConnectWise] List RMA statuses (workflow states for returns). |
cw_list_rma_statuses_info |
Free | Read-only | [ConnectWise] List RMA statuses using the compact 'info' projection. |
cw_list_rma_tags |
Free | Read-only | [ConnectWise] List RMA tag configurations. |
cw_list_shipment_method_usages |
Free | Read-only | [ConnectWise] Retrieve a detailed list of shipment method usages via /usages/list. |
cw_list_shipment_methods_info |
Free | Read-only | [ConnectWise] List shipment methods using the compact 'info' projection. |
cw_list_subcategories |
Free | Read-only | [ConnectWise] List subcategories at the top-level /procurement/subcategories endpoint (distinct from the nested /categories//subcategories path). |
cw_list_subcategories_info |
Free | Read-only | [ConnectWise] List top-level subcategories using the compact 'info' projection. |
cw_list_subcategory_usages |
Free | Read-only | [ConnectWise] Retrieve a detailed list of subcategory usages via /usages/list. |
cw_list_uom_conversions |
Free | Read-only | [ConnectWise] List conversions defined on a unit of measure (e.g., 1 Box = 12 Each). |
cw_list_vendor_purchase_orders |
Free | Read-only | [ConnectWise] List purchase orders for a specific vendor by name. Useful for vendor relationship management -- shows all POs placed with a particular supplier. |
cw_list_warehouse_bin_inventory |
Free | Read-only | [ConnectWise] List inventory-on-hand records for a specific warehouse bin. Shows per-item on-hand counts stored in that bin. |
cw_list_warehouse_bins |
Free | Read-only | [ConnectWise] List storage bins across warehouses. Returns bin name, warehouse, and default flag. |
cw_list_warehouse_bins_info |
Free | Read-only | [ConnectWise] List warehouse bins using the compact 'info' projection. |
cw_list_warehouses_info |
Free | Read-only | [ConnectWise] List warehouses using the compact 'info' projection. Smaller payload, good for selectors. |
cw_rebatch_purchase_order |
Pro | Write | [ConnectWise] Trigger rebatching on a purchase order. CW will recompute batch associations and re-post to GL. |
cw_replace_adjustment |
Pro | Write | [ConnectWise] Replace an adjustment wholesale via PUT. |
cw_replace_adjustment_type |
Pro | Write | [ConnectWise] Replace an adjustment type wholesale via PUT. |
cw_replace_catalog_component |
Pro | Write | [ConnectWise] Replace a catalog component wholesale via PUT. Pass the full component body. |
cw_replace_catalog_item |
Pro | Write | [ConnectWise] Replace a catalog item wholesale via PUT. Pass the full catalog-item body. |
cw_replace_catalog_min_stock |
Pro | Write | [ConnectWise] Replace a catalog min-stock record wholesale via PUT. |
cw_replace_catalog_vendor |
Pro | Write | [ConnectWise] Replace a vendor link on a catalog item via PUT. |
cw_replace_directional_sync |
Pro | Write | [ConnectWise] Replace a directional sync wholesale via PUT. |
cw_replace_invoice_grouping |
Pro | Write | [ConnectWise] Replace an invoice grouping wholesale via PUT. |
cw_replace_manufacturer |
Pro | Write | [ConnectWise] Replace a manufacturer wholesale via PUT. |
cw_replace_po_line_item |
Pro | Write | [ConnectWise] Replace a PO line item wholesale via PUT. |
cw_replace_po_note |
Pro | Write | [ConnectWise] Replace a PO note wholesale via PUT. |
cw_replace_po_status |
Pro | Write | [ConnectWise] Replace a PO status wholesale via PUT. |
cw_replace_po_status_email_template |
Pro | Write | [ConnectWise] Replace a PO status email template wholesale via PUT. |
cw_replace_po_status_notification |
Pro | Write | [ConnectWise] Replace a PO status notification wholesale via PUT. |
cw_replace_pricing_schedule |
Pro | Write | [ConnectWise] Replace a pricing schedule wholesale via PUT. |
cw_replace_pricing_schedule_break |
Pro | Write | [ConnectWise] Replace a pricing schedule break wholesale via PUT. |
cw_replace_pricing_schedule_detail |
Pro | Write | [ConnectWise] Replace a pricing schedule detail wholesale via PUT. |
cw_replace_procurement_category |
Pro | Write | [ConnectWise] Replace a procurement category wholesale via PUT. |
cw_replace_procurement_setting |
Pro | Write | [ConnectWise] Replace a procurement setting wholesale via PUT. |
cw_replace_procurement_subcategory_for_category |
Pro | Write | [ConnectWise] Replace a nested subcategory under a category wholesale via PUT. |
cw_replace_product |
Pro | Write | [ConnectWise] Replace a procurement product wholesale via PUT. |
cw_replace_product_component |
Pro | Write | [ConnectWise] Replace a product component wholesale via PUT. |
cw_replace_product_picking_shipping |
Pro | Write | [ConnectWise] Replace a picking/shipping detail wholesale via PUT. |
cw_replace_product_type |
Pro | Write | [ConnectWise] Replace a product type wholesale via PUT. |
cw_replace_purchase_order |
Pro | Write | [ConnectWise] Replace a purchase order wholesale via PUT. |
cw_replace_rma_action |
Pro | Write | [ConnectWise] Replace an RMA action wholesale via PUT. |
cw_replace_rma_disposition |
Pro | Write | [ConnectWise] Replace an RMA disposition wholesale via PUT. |
cw_replace_rma_status |
Pro | Write | [ConnectWise] Replace an RMA status wholesale via PUT. |
cw_replace_rma_status_email_template |
Pro | Write | [ConnectWise] Replace an RMA status email template wholesale via PUT. |
cw_replace_rma_status_notification |
Pro | Write | [ConnectWise] Replace an RMA status notification wholesale via PUT. |
cw_replace_rma_tag |
Pro | Write | [ConnectWise] Replace an RMA tag wholesale via PUT. |
cw_replace_shipment_method |
Pro | Write | [ConnectWise] Replace a shipment method wholesale via PUT. |
cw_replace_subcategory |
Pro | Write | [ConnectWise] Replace a top-level subcategory wholesale via PUT. |
cw_replace_unit_of_measure |
Pro | Write | [ConnectWise] Replace a unit of measure wholesale via PUT. |
cw_replace_uom_conversion |
Pro | Write | [ConnectWise] Replace a UoM conversion wholesale via PUT. |
cw_replace_warehouse |
Pro | Write | [ConnectWise] Replace a warehouse wholesale via PUT. |
cw_replace_warehouse_bin |
Pro | Write | [ConnectWise] Replace a warehouse bin wholesale via PUT. |
cw_search_catalog_items |
Free | Read-only | [ConnectWise] Search product catalog items by identifier or description. Returns matching catalog entries. Use this when you know the product name or SKU but not the numeric ID. |
cw_search_purchase_orders |
Free | Read-only | [ConnectWise] Search purchase orders by PO number or vendor. Returns matching purchase orders. Use this when you know the PO number or vendor name but not the numeric ID. |
cw_unbatch_purchase_order |
Pro | Write | [ConnectWise] Remove a purchase order from its current accounting batch. |
cw_update_adjustment |
Pro | Write | [ConnectWise] Update an adjustment using JSON Patch operations. |
cw_update_adjustment_type |
Pro | Write | [ConnectWise] Update an adjustment type using JSON Patch operations. |
cw_update_catalog_component |
Pro | Write | [ConnectWise] Update an existing catalog component using JSON Patch operations. |
cw_update_catalog_item |
Pro | Write | [ConnectWise] Update an existing catalog item using JSON Patch operations. Requires a valid catalog item ID — use cw_list_catalog_items to find IDs. Returns the updated catalog item. |
cw_update_catalog_item_pricing |
Pro | Write | [ConnectWise] Apply a pricing update to a catalog item via CW's pricing endpoint. Body is a pricing-change payload. |
cw_update_catalog_min_stock |
Pro | Write | [ConnectWise] Update a catalog minimum-stock threshold using JSON Patch operations. |
cw_update_catalog_vendor |
Pro | Write | [ConnectWise] Update a vendor link on a catalog item using JSON Patch operations. |
cw_update_change_order |
Pro | Write | [ConnectWise] Update a change order using JSON Patch operations. |
cw_update_directional_sync |
Pro | Write | [ConnectWise] Update a directional sync using JSON Patch operations. |
cw_update_invoice_grouping |
Pro | Write | [ConnectWise] Update an invoice grouping using JSON Patch operations. |
cw_update_manufacturer |
Pro | Write | [ConnectWise] Update a manufacturer using JSON Patch operations. |
cw_update_po_line_item |
Pro | Write | [ConnectWise] Update a purchase order line item using JSON Patch operations. |
cw_update_po_note |
Pro | Write | [ConnectWise] Update a PO note using JSON Patch operations. |
cw_update_po_status |
Pro | Write | [ConnectWise] Update a PO status using JSON Patch operations. |
cw_update_po_status_email_template |
Pro | Write | [ConnectWise] Update a PO status email template using JSON Patch operations. |
cw_update_po_status_notification |
Pro | Write | [ConnectWise] Update a PO status notification using JSON Patch operations. |
cw_update_pricing_schedule |
Pro | Write | [ConnectWise] Update a pricing schedule using JSON Patch operations. |
cw_update_pricing_schedule_break |
Pro | Write | [ConnectWise] Update a pricing schedule break using JSON Patch operations. |
cw_update_pricing_schedule_detail |
Pro | Write | [ConnectWise] Update a pricing schedule detail using JSON Patch operations. |
cw_update_procurement_category |
Pro | Write | [ConnectWise] Update a procurement category using JSON Patch operations. |
cw_update_procurement_setting |
Pro | Write | [ConnectWise] Update a procurement setting using JSON Patch operations. |
cw_update_procurement_subcategory_for_category |
Pro | Write | [ConnectWise] Update a nested subcategory under a category using JSON Patch operations. |
cw_update_product |
Pro | Write | [ConnectWise] Update a procurement product using JSON Patch operations. |
cw_update_product_component |
Pro | Write | [ConnectWise] Update a product component using JSON Patch operations. |
cw_update_product_picking_shipping |
Pro | Write | [ConnectWise] Update a picking/shipping detail using JSON Patch operations. |
cw_update_product_type |
Pro | Write | [ConnectWise] Update a product type using JSON Patch operations. |
cw_update_purchase_order |
Pro | Write | [ConnectWise] Update an existing purchase order using JSON Patch operations. Requires a valid purchase order ID — use cw_list_purchase_orders to find IDs. Returns the updated purchase order. |
cw_update_rma_action |
Pro | Write | [ConnectWise] Update an RMA action using JSON Patch operations. |
cw_update_rma_disposition |
Pro | Write | [ConnectWise] Update an RMA disposition using JSON Patch operations. |
cw_update_rma_status |
Pro | Write | [ConnectWise] Update an RMA status using JSON Patch operations. |
cw_update_rma_status_email_template |
Pro | Write | [ConnectWise] Update an RMA status email template using JSON Patch operations. |
cw_update_rma_status_notification |
Pro | Write | [ConnectWise] Update an RMA status notification using JSON Patch operations. |
cw_update_rma_tag |
Pro | Write | [ConnectWise] Update an RMA tag using JSON Patch operations. |
cw_update_shipment_method |
Pro | Write | [ConnectWise] Update a shipment method using JSON Patch operations. |
cw_update_subcategory |
Pro | Write | [ConnectWise] Update a top-level subcategory using JSON Patch operations. |
cw_update_unit_of_measure |
Pro | Write | [ConnectWise] Update a unit of measure using JSON Patch operations. |
cw_update_uom_conversion |
Pro | Write | [ConnectWise] Update a UoM conversion using JSON Patch operations. |
cw_update_warehouse |
Pro | Write | [ConnectWise] Update a warehouse using JSON Patch operations. |
cw_update_warehouse_bin |
Pro | Write | [ConnectWise] Update a warehouse bin using JSON Patch operations. |
cw_bulk_create_po_line_items parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
lineItemsJson |
string | yes | JSON array of line items. Example: [{"product":{"id":1},"quantity":2},{"product":{"id":2},"quantity":5}]. | |
poId |
integer | yes | The purchase order ID. |
cw_bulk_delete_po_line_items parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
lineItemsJson |
string | yes | JSON array listing line items to delete. | |
poId |
integer | yes | The purchase order ID. |
cw_bulk_replace_po_line_items parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
lineItemsJson |
string | yes | JSON array of line items with IDs for replacement. | |
poId |
integer | yes | The purchase order ID. |
cw_copy_catalog_item parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
catalogId |
integer | yes | The source ConnectWise catalog item ID to copy. | |
fieldsJson |
string | yes | Copy options as JSON, typically {"newIdentifier": "..."}. |
cw_copy_purchase_order parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Copy options as JSON (typically to copy with defaults). | |
id |
integer | yes | The source purchase order ID. |
cw_count_adjustment_details parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
adjustmentId |
integer | yes | The parent adjustment ID. | |
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_adjustment_types parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_adjustment_types_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_adjustments parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_catalog_components parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
catalogId |
integer | yes | The ConnectWise catalog bundle item ID. | |
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_catalog_inventory parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
catalogId |
integer | yes | The ConnectWise catalog item ID. | |
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_catalog_items parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "category/name='Hardware'", "inactiveFlag=false". Use '/' for nested fields. |
cw_count_catalog_items_endpoint parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_catalog_items_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_catalog_min_stock parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
catalogId |
integer | yes | The ConnectWise catalog item ID. | |
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_change_orders parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_directional_syncs parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_invoice_groupings parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_manufacturers parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_manufacturers_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_onhand_serials parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_po_line_items parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
poId |
integer | yes | The purchase order ID. |
cw_count_po_notes parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
poId |
integer | yes | The purchase order ID. |
cw_count_po_quick_access parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
id |
integer | yes | The purchase order ID. |
cw_count_po_status_email_templates parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
statusId |
integer | yes | The PO status ID. |
cw_count_po_status_notifications parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
statusId |
integer | yes | The PO status ID. |
cw_count_po_statuses parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_po_statuses_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_pricing_schedule_breaks parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
detailId |
integer | yes | The detail ID. | |
scheduleId |
integer | yes | The pricing schedule ID. |
cw_count_pricing_schedule_details parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
scheduleId |
integer | yes | The parent pricing schedule ID. |
cw_count_pricing_schedules parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_procurement_categories parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_procurement_categories_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_procurement_settings parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_procurement_subcategories_for_category parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
categoryId |
integer | yes | The parent procurement category ID. | |
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_procurement_subcategories_for_category_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
categoryId |
integer | yes | The parent procurement category ID. | |
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_product_components parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
productId |
integer | yes | The procurement product ID. |
cw_count_product_picking_shipping parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
productId |
integer | yes | The procurement product ID. |
cw_count_product_types parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_product_types_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_products parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_purchase_orders parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='Open'", "vendor/identifier='Dell'". Use '/' for nested fields. |
cw_count_purchase_orders_endpoint parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_purchase_orders_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_rma_actions parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_rma_actions_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_rma_dispositions parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_rma_dispositions_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_rma_status_email_templates parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
statusId |
integer | yes | The RMA status ID. |
cw_count_rma_status_notifications parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
statusId |
integer | yes | The RMA status ID. |
cw_count_rma_statuses parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_rma_statuses_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_rma_tags parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_shipment_methods parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_shipment_methods_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_subcategories parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_subcategories_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_unit_of_measures parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_uom_conversions parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
uomId |
integer | yes | The parent unit of measure ID. |
cw_count_warehouse_bin_inventory parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
binId |
integer | yes | The warehouse bin ID. | |
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_warehouse_bins parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_warehouse_bins_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_warehouses parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
cw_count_warehouses_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
cw_create_adjustment parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Adjustment fields as JSON. |
cw_create_adjustment_detail parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
adjustmentId |
integer | yes | The parent adjustment ID. | |
fieldsJson |
string | yes | Detail fields as JSON. |
cw_create_adjustment_type parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Adjustment type fields as JSON. |
cw_create_catalog_component parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
catalogId |
integer | yes | The ConnectWise catalog bundle item ID to attach the component to. | |
fieldsJson |
string | yes | Component fields as JSON. Example: {"catalogItem": {"id": 123}, "quantity": 2}. |
cw_create_catalog_item parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Catalog item fields as JSON. Required: {"identifier": "...", "description": "..."}. Optional: category, subcategory, type, cost, price, vendor, manufacturer, productClass. |
cw_create_catalog_min_stock parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
catalogId |
integer | yes | The ConnectWise catalog item ID. | |
fieldsJson |
string | yes | Min-stock fields as JSON. Example: {"warehouse": {"id": 1}, "minimumStock": 10}. |
cw_create_catalog_vendor_link parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Vendor-link fields as JSON. |
cw_create_change_order parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Change order fields as JSON. |
cw_create_directional_sync parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Directional sync fields as JSON. |
cw_create_manufacturer parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Manufacturer fields as JSON. |
cw_create_po_line_item parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Line item fields as JSON. Required: {"product": {"id": N}, "quantity": N}. Optional: description, cost, serialNumbers, vendorSku. | |
poId |
integer | yes | The numeric ConnectWise purchase order ID to add the line item to. |
cw_create_po_note parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Note fields as JSON. Example: {"text": "Shipment expected 2026-05-01"}. | |
poId |
integer | yes | The purchase order ID. |
cw_create_po_status parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | PO status fields as JSON. |
cw_create_po_status_email_template parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Email template fields as JSON. | |
statusId |
integer | yes | The PO status ID. |
cw_create_po_status_notification parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Notification fields as JSON. | |
statusId |
integer | yes | The PO status ID. |
cw_create_pricing_schedule parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Pricing schedule fields as JSON. |
cw_create_pricing_schedule_break parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
detailId |
integer | yes | The detail ID. | |
fieldsJson |
string | yes | Break fields as JSON. | |
scheduleId |
integer | yes | The pricing schedule ID. |
cw_create_pricing_schedule_detail parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Detail fields as JSON. | |
scheduleId |
integer | yes | The parent pricing schedule ID. |
cw_create_procurement_category parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Category fields as JSON. |
cw_create_procurement_subcategory_for_category parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
categoryId |
integer | yes | The parent procurement category ID. | |
fieldsJson |
string | yes | Subcategory fields as JSON. |
cw_create_product parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Product fields as JSON. Requires catalogItem, quantity, and chargeToId/chargeToType references. |
cw_create_product_component parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Component fields as JSON. | |
productId |
integer | yes | The procurement product ID. |
cw_create_product_picking_shipping parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Picking/shipping detail fields as JSON. | |
productId |
integer | yes | The procurement product ID. |
cw_create_product_type parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Product type fields as JSON. |
cw_create_purchase_order parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Purchase order fields as JSON. Required: {"vendor": {"id": N}}. Optional: status, shippingMethod, shipDate, terms, notes, dropShipFlag. |
cw_create_purchasing_demand parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Purchasing demand fields as JSON. |
cw_create_rma_action parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | RMA action fields as JSON. Example: {"name": "Repair"}. |
cw_create_rma_disposition parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | RMA disposition fields as JSON. Example: {"name": "Scrap"}. |
cw_create_rma_status parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | RMA status fields as JSON. |
cw_create_rma_status_email_template parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Email template fields as JSON. | |
statusId |
integer | yes | The RMA status ID. |
cw_create_rma_status_notification parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Notification fields as JSON. | |
statusId |
integer | yes | The RMA status ID. |
cw_create_rma_tag parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | RMA tag fields as JSON. |
cw_create_shipment_method parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Shipment method fields as JSON. |
cw_create_subcategory parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Subcategory fields as JSON. |
cw_create_unit_of_measure parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Unit of measure fields as JSON. |
cw_create_uom_conversion parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Conversion fields as JSON. Example: {"toUnit": {"id": 2}, "factor": 12}. | |
uomId |
integer | yes | The parent unit of measure ID. |
cw_create_warehouse parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Warehouse fields as JSON. Example: {"name": "Main Warehouse"}. |
cw_create_warehouse_bin parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Warehouse bin fields as JSON. Example: {"warehouse": {"id": 1}, "name": "A1"}. |
cw_delete_adjustment parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The adjustment ID to delete. |
cw_delete_adjustment_detail parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
adjustmentId |
integer | yes | The parent adjustment ID. | |
detailId |
integer | yes | The detail ID to delete. |
cw_delete_adjustment_type parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The adjustment type ID to delete. |
cw_delete_catalog_component parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
catalogId |
integer | yes | The ConnectWise catalog bundle item ID. | |
componentId |
integer | yes | The component ID to delete. |
cw_delete_catalog_item parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise catalog item ID to delete. Verify with cw_get_catalog_item before deleting. |
cw_delete_catalog_min_stock parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
catalogId |
integer | yes | The ConnectWise catalog item ID. | |
minStockId |
integer | yes | The min-stock record ID to delete. |
cw_delete_catalog_vendor parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
catalogId |
integer | yes | The ConnectWise catalog item ID. | |
vendorId |
integer | yes | The vendor link record ID to delete. |
cw_delete_change_order parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The change order ID to delete. |
cw_delete_directional_sync parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The directional sync ID to delete. |
cw_delete_invoice_grouping parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The invoice grouping ID to delete. |
cw_delete_manufacturer parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The manufacturer ID to delete. |
cw_delete_po_line_items parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | Optional ConnectWise conditions filter to narrow which line items are deleted. |
poId |
integer | yes | The purchase order ID. |
cw_delete_po_note parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
noteId |
integer | yes | The note ID to delete. | |
poId |
integer | yes | The purchase order ID. |
cw_delete_po_status parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The PO status ID to delete. |
cw_delete_po_status_email_template parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
statusId |
integer | yes | The PO status ID. | |
templateId |
integer | yes | The email template ID to delete. |
cw_delete_po_status_notification parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
notificationId |
integer | yes | The notification ID to delete. | |
statusId |
integer | yes | The PO status ID. |
cw_delete_pricing_schedule parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The pricing schedule ID to delete. |
cw_delete_pricing_schedule_break parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
breakId |
integer | yes | The break ID to delete. | |
detailId |
integer | yes | The detail ID. | |
scheduleId |
integer | yes | The pricing schedule ID. |
cw_delete_pricing_schedule_detail parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
detailId |
integer | yes | The detail ID to delete. | |
scheduleId |
integer | yes | The parent pricing schedule ID. |
cw_delete_procurement_category parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The procurement category ID to delete. |
cw_delete_procurement_subcategory_for_category parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
categoryId |
integer | yes | The parent procurement category ID. | |
subCategoryId |
integer | yes | The nested subcategory ID to delete. |
cw_delete_product parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The procurement product ID to delete. |
cw_delete_product_component parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
componentId |
integer | yes | The component ID to delete. | |
productId |
integer | yes | The procurement product ID. |
cw_delete_product_picking_shipping parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
detailId |
integer | yes | The detail ID to delete. | |
productId |
integer | yes | The procurement product ID. |
cw_delete_product_type parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The product type ID to delete. |
cw_delete_purchase_order parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise purchase order ID to delete. Verify with cw_get_purchase_order before deleting. |
cw_delete_rma_action parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The RMA action ID to delete. |
cw_delete_rma_disposition parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The RMA disposition ID to delete. |
cw_delete_rma_status parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The RMA status ID to delete. |
cw_delete_rma_status_email_template parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
statusId |
integer | yes | The RMA status ID. | |
templateId |
integer | yes | The email template ID to delete. |
cw_delete_rma_status_notification parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
notificationId |
integer | yes | The notification ID to delete. | |
statusId |
integer | yes | The RMA status ID. |
cw_delete_rma_tag parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The RMA tag ID to delete. |
cw_delete_shipment_method parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The shipment method ID to delete. |
cw_delete_subcategory parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The subcategory ID to delete. |
cw_delete_unit_of_measure parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The unit of measure ID to delete. |
cw_delete_uom_conversion parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conversionId |
integer | yes | The conversion ID to delete. | |
uomId |
integer | yes | The parent unit of measure ID. |
cw_delete_warehouse parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The warehouse ID to delete. |
cw_delete_warehouse_bin parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The warehouse bin ID to delete. |
cw_detach_product parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The procurement product ID to detach. |
cw_discover_procurement_subcategories parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
categoryId |
integer | yes | The numeric ConnectWise procurement category ID. Use cw_discover_procurement_categories to find valid IDs. |
cw_get_adjustment parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The adjustment ID. |
cw_get_adjustment_detail parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
adjustmentId |
integer | yes | The parent adjustment ID. | |
detailId |
integer | yes | The detail ID. |
cw_get_adjustment_type parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The adjustment type ID. |
cw_get_adjustment_type_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The adjustment type ID. |
cw_get_adjustment_type_usages parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The adjustment type ID. |
cw_get_catalog_component parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
catalogId |
integer | yes | The ConnectWise catalog bundle item ID. | |
componentId |
integer | yes | The component ID on the bundle. |
cw_get_catalog_inventory parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
catalogId |
integer | yes | The ConnectWise catalog item ID. | |
inventoryId |
integer | yes | The inventory record ID on that catalog item. |
cw_get_catalog_item parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise catalog item ID. |
cw_get_catalog_item_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
catalogId |
integer | yes | The ConnectWise catalog item ID. |
cw_get_catalog_min_stock parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
catalogId |
integer | yes | The ConnectWise catalog item ID. | |
minStockId |
integer | yes | The min-stock record ID. |
cw_get_catalog_quantity_on_hand parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
catalogItemIdentifier |
string | yes | The catalog item identifier (SKU / product code string), e.g., 'LAPTOP-DELL-7420'. |
cw_get_directional_sync parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The directional sync ID. |
cw_get_invoice_grouping parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The invoice grouping ID. |
cw_get_invoice_grouping_usages parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The invoice grouping ID. |
cw_get_manufacturer parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The manufacturer ID. |
cw_get_manufacturer_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The manufacturer ID. |
cw_get_onhand_serial parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The on-hand serial number record ID. |
cw_get_po_line_item parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
lineItemId |
integer | yes | The line item ID. | |
poId |
integer | yes | The purchase order ID. |
cw_get_po_note parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
noteId |
integer | yes | The note ID. | |
poId |
integer | yes | The purchase order ID. |
cw_get_po_status parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The PO status ID. |
cw_get_po_status_email_template parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
statusId |
integer | yes | The PO status ID. | |
templateId |
integer | yes | The email template ID. |
cw_get_po_status_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The PO status ID. |
cw_get_po_status_notification parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
notificationId |
integer | yes | The notification ID. | |
statusId |
integer | yes | The PO status ID. |
cw_get_po_status_usages parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The PO status ID. |
cw_get_pricing_schedule parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The pricing schedule ID. |
cw_get_pricing_schedule_break parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
breakId |
integer | yes | The break ID. | |
detailId |
integer | yes | The detail ID. | |
scheduleId |
integer | yes | The pricing schedule ID. |
cw_get_pricing_schedule_detail parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
detailId |
integer | yes | The detail ID. | |
scheduleId |
integer | yes | The parent pricing schedule ID. |
cw_get_procurement_category parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The procurement category ID. |
cw_get_procurement_category_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The procurement category ID. |
cw_get_procurement_setting parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The procurement setting ID. |
cw_get_procurement_subcategory_for_category parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
categoryId |
integer | yes | The parent procurement category ID. | |
subCategoryId |
integer | yes | The nested subcategory ID. |
cw_get_procurement_subcategory_for_category_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
categoryId |
integer | yes | The parent procurement category ID. | |
subCategoryId |
integer | yes | The nested subcategory ID. |
cw_get_product parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric procurement product ID. |
cw_get_product_component parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
componentId |
integer | yes | The component ID on that product. | |
productId |
integer | yes | The procurement product ID. |
cw_get_product_picking_shipping parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
detailId |
integer | yes | The picking/shipping detail ID. | |
productId |
integer | yes | The procurement product ID. |
cw_get_product_type parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The product type ID. |
cw_get_product_type_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The product type ID. |
cw_get_product_type_usages parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The product type ID. |
cw_get_purchase_order parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise purchase order ID. |
cw_get_purchase_order_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The purchase order ID. |
cw_get_rma_action parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The RMA action ID. |
cw_get_rma_action_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The RMA action ID. |
cw_get_rma_disposition parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The RMA disposition ID. |
cw_get_rma_disposition_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The RMA disposition ID. |
cw_get_rma_status parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The RMA status ID. |
cw_get_rma_status_email_template parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
statusId |
integer | yes | The RMA status ID. | |
templateId |
integer | yes | The email template ID. |
cw_get_rma_status_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The RMA status ID. |
cw_get_rma_status_notification parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
notificationId |
integer | yes | The notification ID. | |
statusId |
integer | yes | The RMA status ID. |
cw_get_rma_status_usages parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The RMA status ID. |
cw_get_rma_tag parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The RMA tag ID. |
cw_get_shipment_method parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The shipment method ID. |
cw_get_shipment_method_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The shipment method ID. |
cw_get_shipment_method_usages parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The shipment method ID. |
cw_get_subcategory parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The subcategory ID. |
cw_get_subcategory_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The subcategory ID. |
cw_get_subcategory_usages parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The subcategory ID. |
cw_get_unit_of_measure parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The unit of measure ID. |
cw_get_uom_conversion parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conversionId |
integer | yes | The conversion ID. | |
uomId |
integer | yes | The parent unit of measure ID. |
cw_get_warehouse parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise warehouse ID. |
cw_get_warehouse_bin parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric warehouse bin ID. |
cw_get_warehouse_bin_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric warehouse bin ID. |
cw_get_warehouse_bin_inventory parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
binId |
integer | yes | The warehouse bin ID. | |
inventoryId |
integer | yes | The inventory-on-hand record ID. |
cw_get_warehouse_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise warehouse ID. |
cw_list_adjustment_details parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
adjustmentId |
integer | yes | The parent adjustment ID. | |
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_adjustment_type_usages parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The adjustment type ID. |
cw_list_adjustment_types parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_adjustment_types_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_adjustments parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_catalog_components parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
catalogId |
integer | yes | The ConnectWise catalog bundle item ID. | |
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_catalog_inventory parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
catalogId |
integer | yes | The ConnectWise catalog item ID whose inventory to list. | |
conditions |
string | no | null | ConnectWise conditions filter. Use '/' for nested fields. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_catalog_items parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "identifier contains 'laptop'", "category/name='Hardware'". Use '/' for nested fields, 'and'/'or' for boolean logic. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_catalog_items_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_catalog_min_stock parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
catalogId |
integer | yes | The ConnectWise catalog item ID. | |
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_catalog_vendors parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
catalogId |
integer | yes | The ConnectWise catalog item ID. |
cw_list_change_orders parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_directional_syncs parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_invoice_grouping_usages parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The invoice grouping ID. |
cw_list_invoice_groupings parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_manufacturers_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_onhand_serials parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_open_purchase_orders parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_po_line_items parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
poId |
integer | yes | The numeric ConnectWise purchase order ID. |
cw_list_po_notes parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
poId |
integer | yes | The purchase order ID. |
cw_list_po_status_email_templates parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
statusId |
integer | yes | The PO status ID. |
cw_list_po_status_notifications parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
statusId |
integer | yes | The PO status ID. |
cw_list_po_status_usages parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The PO status ID. |
cw_list_po_statuses_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_pricing_schedule_breaks parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
detailId |
integer | yes | The pricing schedule detail ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
scheduleId |
integer | yes | The pricing schedule ID. |
cw_list_pricing_schedule_details parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
scheduleId |
integer | yes | The parent pricing schedule ID. |
cw_list_pricing_schedules parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_procurement_categories_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_procurement_settings parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_procurement_subcategories_for_category_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
categoryId |
integer | yes | The parent procurement category ID. | |
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_product_components parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
productId |
integer | yes | The procurement product ID (parent bundle). |
cw_list_product_picking_shipping parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
productId |
integer | yes | The procurement product ID. |
cw_list_product_type_usages parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The product type ID. |
cw_list_product_types_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_products parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Example: "chargeToType='Project' AND chargeToId=42". |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_purchase_orders parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='Open'", "vendor/identifier='Dell'". Use '/' for nested fields, 'and'/'or' for boolean logic. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_purchase_orders_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_rma_actions parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_rma_actions_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_rma_dispositions parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_rma_dispositions_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_rma_status_email_templates parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
statusId |
integer | yes | The RMA status ID. |
cw_list_rma_status_notifications parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
statusId |
integer | yes | The RMA status ID. |
cw_list_rma_status_usages parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The RMA status ID. |
cw_list_rma_statuses parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_rma_statuses_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_rma_tags parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_shipment_method_usages parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The shipment method ID. |
cw_list_shipment_methods_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_subcategories parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_subcategories_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_subcategory_usages parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The subcategory ID. |
cw_list_uom_conversions parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
uomId |
integer | yes | The parent unit of measure ID. |
cw_list_vendor_purchase_orders parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
vendorName |
string | yes | The vendor company name to filter by (exact or partial match). |
cw_list_warehouse_bin_inventory parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
binId |
integer | yes | The warehouse bin ID. | |
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_warehouse_bins parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Example: "warehouse/id=1". |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_warehouse_bins_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_warehouses_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_rebatch_purchase_order parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The purchase order ID. |
cw_replace_adjustment parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Full adjustment JSON payload. | |
id |
integer | yes | The adjustment ID. |
cw_replace_adjustment_type parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Full adjustment type JSON payload. | |
id |
integer | yes | The adjustment type ID. |
cw_replace_catalog_component parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
catalogId |
integer | yes | The ConnectWise catalog bundle item ID. | |
componentId |
integer | yes | The component ID on the bundle. | |
fieldsJson |
string | yes | Full component JSON payload. |
cw_replace_catalog_item parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
catalogId |
integer | yes | The ConnectWise catalog item ID. | |
fieldsJson |
string | yes | Full catalog-item JSON payload. |
cw_replace_catalog_min_stock parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
catalogId |
integer | yes | The ConnectWise catalog item ID. | |
fieldsJson |
string | yes | Full min-stock JSON payload. | |
minStockId |
integer | yes | The min-stock record ID to replace. |
cw_replace_catalog_vendor parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
catalogId |
integer | yes | The ConnectWise catalog item ID. | |
fieldsJson |
string | yes | Full vendor-link JSON payload. | |
vendorId |
integer | yes | The vendor link record ID. |
cw_replace_directional_sync parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Full directional sync JSON payload. | |
id |
integer | yes | The directional sync ID. |
cw_replace_invoice_grouping parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Full invoice grouping JSON payload. | |
id |
integer | yes | The invoice grouping ID. |
cw_replace_manufacturer parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Full manufacturer JSON payload. | |
id |
integer | yes | The manufacturer ID. |
cw_replace_po_line_item parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Full line item JSON payload. | |
lineItemId |
integer | yes | The line item ID. | |
poId |
integer | yes | The purchase order ID. |
cw_replace_po_note parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Full note JSON payload. | |
noteId |
integer | yes | The note ID. | |
poId |
integer | yes | The purchase order ID. |
cw_replace_po_status parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Full PO status JSON payload. | |
id |
integer | yes | The PO status ID. |
cw_replace_po_status_email_template parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Full email template JSON payload. | |
statusId |
integer | yes | The PO status ID. | |
templateId |
integer | yes | The email template ID. |
cw_replace_po_status_notification parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Full notification JSON payload. | |
notificationId |
integer | yes | The notification ID. | |
statusId |
integer | yes | The PO status ID. |
cw_replace_pricing_schedule parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Full pricing schedule JSON payload. | |
id |
integer | yes | The pricing schedule ID. |
cw_replace_pricing_schedule_break parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
breakId |
integer | yes | The break ID. | |
detailId |
integer | yes | The detail ID. | |
fieldsJson |
string | yes | Full break JSON payload. | |
scheduleId |
integer | yes | The pricing schedule ID. |
cw_replace_pricing_schedule_detail parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
detailId |
integer | yes | The detail ID. | |
fieldsJson |
string | yes | Full detail JSON payload. | |
scheduleId |
integer | yes | The parent pricing schedule ID. |
cw_replace_procurement_category parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Full category JSON payload. | |
id |
integer | yes | The procurement category ID. |
cw_replace_procurement_setting parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Full setting JSON payload. | |
id |
integer | yes | The procurement setting ID. |
cw_replace_procurement_subcategory_for_category parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
categoryId |
integer | yes | The parent procurement category ID. | |
fieldsJson |
string | yes | Full subcategory JSON payload. | |
subCategoryId |
integer | yes | The nested subcategory ID. |
cw_replace_product parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Full product JSON payload. | |
id |
integer | yes | The numeric procurement product ID. |
cw_replace_product_component parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
componentId |
integer | yes | The component ID. | |
fieldsJson |
string | yes | Full component JSON payload. | |
productId |
integer | yes | The procurement product ID. |
cw_replace_product_picking_shipping parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
detailId |
integer | yes | The picking/shipping detail ID. | |
fieldsJson |
string | yes | Full detail JSON payload. | |
productId |
integer | yes | The procurement product ID. |
cw_replace_product_type parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Full product type JSON payload. | |
id |
integer | yes | The product type ID. |
cw_replace_purchase_order parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Full purchase order JSON payload. | |
id |
integer | yes | The purchase order ID. |
cw_replace_rma_action parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Full RMA action JSON payload. | |
id |
integer | yes | The RMA action ID. |
cw_replace_rma_disposition parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Full disposition JSON payload. | |
id |
integer | yes | The RMA disposition ID. |
cw_replace_rma_status parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Full RMA status JSON payload. | |
id |
integer | yes | The RMA status ID. |
cw_replace_rma_status_email_template parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Full email template JSON payload. | |
statusId |
integer | yes | The RMA status ID. | |
templateId |
integer | yes | The email template ID. |
cw_replace_rma_status_notification parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Full notification JSON payload. | |
notificationId |
integer | yes | The notification ID. | |
statusId |
integer | yes | The RMA status ID. |
cw_replace_rma_tag parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Full RMA tag JSON payload. | |
id |
integer | yes | The RMA tag ID. |
cw_replace_shipment_method parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Full shipment method JSON payload. | |
id |
integer | yes | The shipment method ID. |
cw_replace_subcategory parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Full subcategory JSON payload. | |
id |
integer | yes | The subcategory ID. |
cw_replace_unit_of_measure parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Full UoM JSON payload. | |
id |
integer | yes | The unit of measure ID. |
cw_replace_uom_conversion parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conversionId |
integer | yes | The conversion ID. | |
fieldsJson |
string | yes | Full conversion JSON payload. | |
uomId |
integer | yes | The parent unit of measure ID. |
cw_replace_warehouse parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Full warehouse JSON payload. | |
id |
integer | yes | The numeric ConnectWise warehouse ID. |
cw_replace_warehouse_bin parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Full warehouse bin JSON payload. | |
id |
integer | yes | The numeric warehouse bin ID. |
cw_search_catalog_items parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
search |
string | yes | Search text to match against catalog item identifier and description. |
cw_search_purchase_orders parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
search |
string | yes | Search text to match against purchase order number or vendor identifier. |
cw_unbatch_purchase_order parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The purchase order ID. |
cw_update_adjustment parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The adjustment ID. | |
patchJson |
string | yes | JSON array of patch operations. |
cw_update_adjustment_type parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The adjustment type ID. | |
patchJson |
string | yes | JSON array of patch operations. |
cw_update_catalog_component parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
catalogId |
integer | yes | The ConnectWise catalog bundle item ID. | |
componentId |
integer | yes | The component ID on the bundle. | |
patchJson |
string | yes | JSON array of patch operations. Example: [{"op": "replace", "path": "quantity", "value": 3}]. |
cw_update_catalog_item parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise catalog item ID to update. | |
patchJson |
string | yes | JSON array of patch operations. Example: [{"op": "replace", "path": "price", "value": 99.99}] |
cw_update_catalog_item_pricing parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
catalogId |
integer | yes | The ConnectWise catalog item ID. | |
fieldsJson |
string | yes | Pricing update payload as JSON. |
cw_update_catalog_min_stock parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
catalogId |
integer | yes | The ConnectWise catalog item ID. | |
minStockId |
integer | yes | The min-stock record ID to update. | |
patchJson |
string | yes | JSON array of patch operations. |
cw_update_catalog_vendor parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
catalogId |
integer | yes | The ConnectWise catalog item ID. | |
patchJson |
string | yes | JSON array of patch operations. | |
vendorId |
integer | yes | The vendor link record ID. |
cw_update_change_order parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The change order ID. | |
patchJson |
string | yes | JSON array of patch operations. |
cw_update_directional_sync parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The directional sync ID. | |
patchJson |
string | yes | JSON array of patch operations. |
cw_update_invoice_grouping parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The invoice grouping ID. | |
patchJson |
string | yes | JSON array of patch operations. |
cw_update_manufacturer parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The manufacturer ID. | |
patchJson |
string | yes | JSON array of patch operations. |
cw_update_po_line_item parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
lineItemId |
integer | yes | The line item ID to update. | |
patchJson |
string | yes | JSON array of patch operations. | |
poId |
integer | yes | The purchase order ID. |
cw_update_po_note parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
noteId |
integer | yes | The note ID. | |
patchJson |
string | yes | JSON array of patch operations. | |
poId |
integer | yes | The purchase order ID. |
cw_update_po_status parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The PO status ID. | |
patchJson |
string | yes | JSON array of patch operations. |
cw_update_po_status_email_template parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
patchJson |
string | yes | JSON array of patch operations. | |
statusId |
integer | yes | The PO status ID. | |
templateId |
integer | yes | The email template ID. |
cw_update_po_status_notification parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
notificationId |
integer | yes | The notification ID. | |
patchJson |
string | yes | JSON array of patch operations. | |
statusId |
integer | yes | The PO status ID. |
cw_update_pricing_schedule parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The pricing schedule ID. | |
patchJson |
string | yes | JSON array of patch operations. |
cw_update_pricing_schedule_break parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
breakId |
integer | yes | The break ID. | |
detailId |
integer | yes | The detail ID. | |
patchJson |
string | yes | JSON array of patch operations. | |
scheduleId |
integer | yes | The pricing schedule ID. |
cw_update_pricing_schedule_detail parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
detailId |
integer | yes | The detail ID. | |
patchJson |
string | yes | JSON array of patch operations. | |
scheduleId |
integer | yes | The parent pricing schedule ID. |
cw_update_procurement_category parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The procurement category ID. | |
patchJson |
string | yes | JSON array of patch operations. |
cw_update_procurement_setting parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The procurement setting ID. | |
patchJson |
string | yes | JSON array of patch operations. |
cw_update_procurement_subcategory_for_category parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
categoryId |
integer | yes | The parent procurement category ID. | |
patchJson |
string | yes | JSON array of patch operations. | |
subCategoryId |
integer | yes | The nested subcategory ID. |
cw_update_product parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric procurement product ID. | |
patchJson |
string | yes | JSON array of patch operations. |
cw_update_product_component parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
componentId |
integer | yes | The component ID. | |
patchJson |
string | yes | JSON array of patch operations. | |
productId |
integer | yes | The procurement product ID. |
cw_update_product_picking_shipping parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
detailId |
integer | yes | The picking/shipping detail ID. | |
patchJson |
string | yes | JSON array of patch operations. | |
productId |
integer | yes | The procurement product ID. |
cw_update_product_type parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The product type ID. | |
patchJson |
string | yes | JSON array of patch operations. |
cw_update_purchase_order parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise purchase order ID to update. | |
patchJson |
string | yes | JSON array of patch operations. Example: [{"op": "replace", "path": "status", "value": {"id": 2}}] |
cw_update_rma_action parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The RMA action ID. | |
patchJson |
string | yes | JSON array of patch operations. |
cw_update_rma_disposition parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The RMA disposition ID. | |
patchJson |
string | yes | JSON array of patch operations. |
cw_update_rma_status parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The RMA status ID. | |
patchJson |
string | yes | JSON array of patch operations. |
cw_update_rma_status_email_template parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
patchJson |
string | yes | JSON array of patch operations. | |
statusId |
integer | yes | The RMA status ID. | |
templateId |
integer | yes | The email template ID. |
cw_update_rma_status_notification parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
notificationId |
integer | yes | The notification ID. | |
patchJson |
string | yes | JSON array of patch operations. | |
statusId |
integer | yes | The RMA status ID. |
cw_update_rma_tag parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The RMA tag ID. | |
patchJson |
string | yes | JSON array of patch operations. |
cw_update_shipment_method parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The shipment method ID. | |
patchJson |
string | yes | JSON array of patch operations. |
cw_update_subcategory parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The subcategory ID. | |
patchJson |
string | yes | JSON array of patch operations. |
cw_update_unit_of_measure parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The unit of measure ID. | |
patchJson |
string | yes | JSON array of patch operations. |
cw_update_uom_conversion parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conversionId |
integer | yes | The conversion ID. | |
patchJson |
string | yes | JSON array of patch operations. | |
uomId |
integer | yes | The parent unit of measure ID. |
cw_update_warehouse parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise warehouse ID. | |
patchJson |
string | yes | JSON array of patch operations. Example: [{"op": "replace", "path": "name", "value": "Warehouse A"}]. |
cw_update_warehouse_bin parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric warehouse bin ID. | |
patchJson |
string | yes | JSON array of patch operations. |
Expenses
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_count_expense_entries |
Free | Read-only | [ConnectWise] Get a count of expense entries matching optional conditions. Returns a single-record result for counting. Useful for expense reporting dashboards or checking result set size before paginating with cw_list_expense_entries. |
cw_count_expense_reports |
Free | Read-only | [ConnectWise] Get a count of expense reports matching optional conditions. Returns a single-record result for counting. Useful for tracking expense report submission backlogs. |
cw_create_expense_entry |
Pro | Write | [ConnectWise] Create a new expense entry. Requires at minimum a member reference, amount, and date. Returns the created expense entry with its assigned ID. This creates an expense record visible to accounting staff. |
cw_delete_expense_entry |
Pro | Destructive | [ConnectWise] Permanently delete an expense entry by ID. This cannot be undone. Verify the entry with cw_get_expense_entry before deleting. Requires a valid expense entry ID. |
cw_discover_expense_types |
Free | Read-only | [ConnectWise] List all expense types configured in ConnectWise. Returns type IDs and names. Use to discover valid expense types when creating or filtering expense entries. |
cw_get_expense_entry |
Free | Read-only | [ConnectWise] Retrieve a single expense entry by ID. Returns full expense entry details including member, amount, date, type, classification, company, charge-to reference, payment method, and notes. Requires a valid expense entry ID — use cw_list_expense_entries to find IDs. |
cw_get_expense_report |
Free | Read-only | [ConnectWise] Retrieve a single expense report by ID. Returns full expense report details including member, status, total amount, entries, and approval info. Requires a valid expense report ID — use cw_list_expense_reports to find IDs. |
cw_list_expense_entries |
Free | Read-only | [ConnectWise] List expense entries with optional filtering. Returns paginated expense records including member, amount, date, type, company, and charge-to references. Use this to browse expense entries or narrow results before fetching full details with cw_get_expense_entry. |
cw_list_expense_reports |
Free | Read-only | [ConnectWise] List expense reports with optional filtering. Returns paginated expense report records including member, status, total, and date range. Use to browse submitted expense reports or track approval status. |
cw_list_member_expenses |
Free | Read-only | [ConnectWise] List expense entries for a specific member by identifier. A convenience tool that filters expenses to a single member. Useful for reviewing a technician's or salesperson's submitted expenses. |
cw_list_pending_expense_reports |
Free | Read-only | [ConnectWise] List expense reports awaiting approval. Returns expense reports with status 'Open' that need manager review. Useful for finance workflow management and approval queue monitoring. |
cw_search_expense_entries |
Free | Read-only | [ConnectWise] Search expense entries by member identifier or notes text. Returns matching expense entries. Use this when you know the member or keyword but want to find related expense records. |
cw_search_expense_reports |
Free | Read-only | [ConnectWise] Search expense reports by member identifier. Returns matching expense reports. Use this when you want to find expense report submissions for a specific member. |
cw_update_expense_entry |
Pro | Write | [ConnectWise] Update an existing expense entry using JSON Patch operations. Requires a valid expense entry ID — use cw_list_expense_entries to find IDs. Returns the updated expense entry. |
cw_count_expense_entries parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "member/identifier='jsmith'", "amount>100". Use '/' for nested fields. |
cw_count_expense_reports parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='Open'", "member/identifier='jsmith'". Use '/' for nested fields. |
cw_create_expense_entry parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Expense entry fields as JSON. Required: {"member": {"identifier": "..."}, "amount": N, "date": "yyyy-MM-dd"}. Optional: type, company, chargeToId, chargeToType, classification, paymentMethod, notes. |
cw_delete_expense_entry parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise expense entry ID to delete. Verify with cw_get_expense_entry before deleting. |
cw_get_expense_entry parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise expense entry ID. |
cw_get_expense_report parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise expense report ID. |
cw_list_expense_entries parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "member/identifier='jsmith'", "amount>100", "date>=[2024-01-01]". Use '/' for nested fields, 'and'/'or' for boolean logic. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_expense_reports parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "member/identifier='jsmith'", "status/name='Open'". Use '/' for nested fields, 'and'/'or' for boolean logic. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_member_expenses parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
memberIdentifier |
string | yes | The ConnectWise member identifier (e.g., 'jsmith'). | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_pending_expense_reports parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_search_expense_entries parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
search |
string | yes | Search text to match against member identifier or notes. |
cw_search_expense_reports parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
search |
string | yes | Search text to match against member identifier. |
cw_update_expense_entry parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise expense entry ID to update. | |
patchJson |
string | yes | JSON array of patch operations. Example: [{"op": "replace", "path": "amount", "value": 150.00}] |
Marketing
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_count_campaigns |
Free | Read-only | [ConnectWise] Get a count of marketing campaigns matching optional conditions. Returns a single-record result for counting. Useful for marketing dashboards or checking result set size. |
cw_create_campaign |
Pro | Write | [ConnectWise] Create a new marketing campaign. Requires at minimum a name. Returns the created campaign with its assigned ID. This creates a campaign record visible to marketing staff. |
cw_delete_campaign |
Pro | Destructive | [ConnectWise] Permanently delete a marketing campaign by ID. This cannot be undone. Verify the campaign with cw_get_campaign before deleting. Requires a valid campaign ID. |
cw_discover_campaign_statuses |
Free | Read-only | [ConnectWise] List all campaign statuses configured in ConnectWise. Returns status IDs and names. Use to discover valid campaign statuses when creating or filtering campaigns. |
cw_discover_campaign_subtypes |
Free | Read-only | [ConnectWise] List all campaign sub-types configured in ConnectWise. Returns sub-type IDs and names. Use to discover valid campaign sub-types when creating or filtering campaigns. |
cw_discover_campaign_types |
Free | Read-only | [ConnectWise] List all campaign types configured in ConnectWise. Returns type IDs and names. Use to discover valid campaign types when creating or filtering campaigns. |
cw_get_campaign |
Free | Read-only | [ConnectWise] Retrieve a single marketing campaign by ID. Returns full campaign details including name, type, sub-type, status, start/end dates, budget, actual cost, revenue, and notes. Requires a valid campaign ID — use cw_list_campaigns to find IDs. |
cw_get_marketing_group |
Free | Read-only | [ConnectWise] Retrieve a single marketing group by ID. Returns full group details including name, type, and associated companies and contacts. Requires a valid marketing group ID — use cw_list_marketing_groups to find IDs. |
cw_list_active_campaigns |
Free | Read-only | [ConnectWise] List marketing campaigns with active status. Useful for reviewing currently running marketing initiatives. Returns only campaigns where status is 'Active'. |
cw_list_campaign_activities |
Free | Read-only | [ConnectWise] List sales activities linked to a specific campaign. A convenience tool that filters activities by campaign ID. Useful for tracking campaign effectiveness and follow-up activity. |
cw_list_campaigns |
Free | Read-only | [ConnectWise] List marketing campaigns with optional filtering. Returns paginated campaign records including name, type, status, start/end dates, and budget. Use this to browse campaigns or narrow results before fetching full details with cw_get_campaign. |
cw_list_marketing_group_companies |
Free | Read-only | [ConnectWise] List companies associated with a marketing group. Returns company records linked to the specified group. Use to see which companies are targeted by a marketing group. |
cw_list_marketing_group_contacts |
Free | Read-only | [ConnectWise] List contacts associated with a marketing group. Returns contact records linked to the specified group. Use to see which individual contacts are targeted by a marketing group. |
cw_list_marketing_groups |
Free | Read-only | [ConnectWise] List marketing groups with optional filtering. Returns paginated group records including name, type, and member counts. Use to discover target audience groups for campaigns. |
cw_search_campaigns |
Free | Read-only | [ConnectWise] Search marketing campaigns by name. Returns matching campaigns. Use this when you know the campaign name but not the numeric ID. |
cw_update_campaign |
Pro | Write | [ConnectWise] Update an existing marketing campaign using JSON Patch operations. Requires a valid campaign ID — use cw_list_campaigns to find IDs. Returns the updated campaign. |
cw_count_campaigns parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='Active'". Use '/' for nested fields. |
cw_create_campaign parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Campaign fields as JSON. Required: {"name": "..."}. Optional: type, subType, status, startDate, endDate, budget, locationId, notes. |
cw_delete_campaign parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise campaign ID to delete. Verify with cw_get_campaign before deleting. |
cw_get_campaign parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise campaign ID. |
cw_get_marketing_group parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise marketing group ID. |
cw_list_active_campaigns parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_campaign_activities parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
campaignId |
integer | yes | The numeric ConnectWise campaign ID. | |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_campaigns parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "name contains 'Q4'", "status/name='Active'". Use '/' for nested fields, 'and'/'or' for boolean logic. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_marketing_group_companies parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
groupId |
integer | yes | The numeric ConnectWise marketing group ID. Use cw_list_marketing_groups to find valid IDs. |
cw_list_marketing_group_contacts parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
groupId |
integer | yes | The numeric ConnectWise marketing group ID. Use cw_list_marketing_groups to find valid IDs. |
cw_search_campaigns parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
search |
string | yes | Search text to match against campaign name. |
cw_update_campaign parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise campaign ID to update. | |
patchJson |
string | yes | JSON array of patch operations. Example: [{"op": "replace", "path": "status", "value": {"name": "Active"}}] |
Knowledge Base
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_count_kb_articles |
Free | Read-only | [ConnectWise] Get a count of knowledge base articles matching optional conditions. Returns a single-record result for counting. Useful for measuring KB coverage or checking result set size. |
cw_create_kb_article |
Pro | Write | [ConnectWise] Create a new knowledge base article. Requires a title and content. Call cw_discover_kb_categories first to find valid category/subcategory IDs. Returns the created article with its assigned ID. |
cw_discover_kb_categories |
Free | Read-only | [ConnectWise] List all knowledge base categories. Returns category IDs and names. Categories organize KB articles into logical groups. Call this to discover valid category values before creating articles with cw_create_kb_article. |
cw_discover_kb_subcategories |
Free | Read-only | [ConnectWise] List all knowledge base subcategories. Returns subcategory IDs, names, and parent category references. Subcategories provide a second level of KB article organization under categories. Call this to discover valid subcategory values. |
cw_get_kb_article |
Free | Read-only | [ConnectWise] Retrieve a single knowledge base article by ID. Returns full article details including title, issue, resolution, category, and subcategory. Use cw_list_kb_articles to find valid article IDs. |
cw_list_kb_articles |
Free | Read-only | [ConnectWise] List knowledge base articles with optional filtering. Returns paginated article summaries including ID, title, and category. Use this to browse available KB content or narrow results before fetching full articles with cw_get_kb_article. |
cw_list_recent_kb_articles |
Free | Read-only | [ConnectWise] List the most recently created knowledge base articles. Useful for reviewing new documentation additions and ensuring KB coverage is up to date. Ordered by creation date descending. |
cw_search_kb_articles |
Free | Read-only | [ConnectWise] Search knowledge base articles by title or content keyword. Returns matching articles. Use this for natural-language KB lookups when troubleshooting issues. |
cw_update_kb_article |
Pro | Write | [ConnectWise] Update an existing knowledge base article using JSON Patch operations. Requires a valid article ID — use cw_list_kb_articles to find IDs. Returns the updated article. |
cw_count_kb_articles parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "category/name='Network'". Use '/' for nested fields. |
cw_create_kb_article parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Article fields as JSON. Required: {"title": "...", "issue": "...", "resolution": "..."}. Optional: category, subCategory, board. |
cw_discover_kb_categories parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='New'", "company/id=123 and priority/name!='Low'". Use '/' for nested fields, 'and'/'or' for boolean logic. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_discover_kb_subcategories parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='New'", "company/id=123 and priority/name!='Low'". Use '/' for nested fields, 'and'/'or' for boolean logic. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_get_kb_article parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric KB article ID. Use cw_list_kb_articles to find valid IDs. |
cw_list_kb_articles parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "status/name='New'", "company/id=123 and priority/name!='Low'". Use '/' for nested fields, 'and'/'or' for boolean logic. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_recent_kb_articles parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_search_kb_articles parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
search |
string | yes | Search text to match against article title, issue, and resolution fields. |
cw_update_kb_article parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric KB article ID to update. | |
patchJson |
string | yes | JSON array of patch operations. Example: [{"op": "replace", "path": "resolution", "value": "Updated resolution text"}] |
Workflows
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_get_workflow |
Free | Read-only | [ConnectWise] Retrieve a single workflow by ID. Returns full workflow details including name, table reference, activation status, and batch interval. Requires a valid workflow ID — use cw_list_workflows to find IDs. |
cw_list_workflow_events |
Free | Read-only | [ConnectWise] List events configured for a workflow. Returns event records including event type, execution order, and notification settings. Use to understand what actions a workflow performs when triggered. |
cw_list_workflow_triggers |
Free | Read-only | [ConnectWise] List triggers configured for a workflow. Returns trigger records including trigger type, expected fields, and conditions. Use to understand what activates a workflow. |
cw_list_workflows |
Free | Read-only | [ConnectWise] List automation workflows with optional filtering. Returns paginated workflow records including name, table reference, and activation status. Use this to discover configured workflows or audit automation rules. |
cw_search_workflows |
Free | Read-only | [ConnectWise] Search workflows by name. Returns matching workflow records. Use this when you know the workflow name but not the numeric ID. |
cw_get_workflow parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise workflow ID. |
cw_list_workflow_events parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
workflowId |
integer | yes | The numeric ConnectWise workflow ID. Use cw_list_workflows to find valid IDs. |
cw_list_workflow_triggers parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
workflowId |
integer | yes | The numeric ConnectWise workflow ID. Use cw_list_workflows to find valid IDs. |
cw_list_workflows parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "name contains 'Ticket'", "activateFlag=true". Use '/' for nested fields, 'and'/'or' for boolean logic. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_search_workflows parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
search |
string | yes | Search text to match against workflow name. |
System Discovery
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_get_document |
Free | Read-only | [ConnectWise] Get document metadata by ID including title, filename, and linked record info. Requires a valid document ID — use cw_list_documents to find IDs. |
cw_list_documents |
Free | Read-only | [ConnectWise] List documents attached to a specific record. Returns document IDs, titles, and metadata. recordType and recordId are REQUIRED — the ConnectWise system/documents endpoint is entity-scoped and returns a 400 error without them. Use the parent record's type (e.g. 'Ticket', 'Company', 'Contact', 'Project') and its numeric ID. |
cw_list_locations |
Free | Read-only | [ConnectWise] List system locations with optional filtering and pagination. Returns location IDs and names. Use these values when filtering or assigning location-scoped data such as members and tickets. |
cw_search_documents |
Free | Read-only | [ConnectWise] Search documents by title within a specific record. Returns matching document records. recordType and recordId are REQUIRED — the ConnectWise system/documents endpoint is entity-scoped and returns a 400 error without them. Use the parent record's type (e.g. 'Ticket', 'Company', 'Contact', 'Project') and its numeric ID. |
cw_get_document parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise document ID. |
cw_list_documents parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "title contains 'SOP'". Use '/' for nested fields. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
recordId |
integer | yes | The numeric ID of the parent record. | |
recordType |
string | yes | The type of the parent record the documents are attached to (e.g. 'Ticket', 'Company', 'Contact', 'Project'). |
cw_list_locations parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "name='Main Office'". Use '/' for nested fields. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_search_documents parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
recordId |
integer | yes | The numeric ID of the parent record. | |
recordType |
string | yes | The type of the parent record the documents are attached to (e.g. 'Ticket', 'Company', 'Contact', 'Project'). | |
search |
string | yes | Search text to match against document title. |
System Utilities
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_count_callbacks |
Free | Read-only | [ConnectWise] Count total registered callback entries (webhooks), with optional active/inactive filtering. Returns the count and a list of callbacks. Use for quick integration audits. |
cw_create_callback |
Pro | Write | [ConnectWise] Register a new callback entry (webhook). Creates a callback that will POST event notifications to the specified URL when the configured object type changes. Returns the created callback with its assigned ID. |
cw_delete_callback |
Pro | Destructive | [ConnectWise] Permanently delete a callback entry (webhook) by ID. This cannot be undone and will stop event notifications to the registered URL. Verify the callback with cw_list_callbacks before deleting. |
cw_list_active_callbacks |
Free | Read-only | [ConnectWise] List only active callback entries (webhooks) that are currently enabled. Returns callback records filtered to active status. Use to audit which integrations are actively receiving event notifications. |
cw_list_audit_trail |
Free | Read-only | [ConnectWise] List the audit-trail history for ONE record. ConnectWise scopes the audit trail per record, so you MUST supply both the record type and its numeric id (a bare/global list is not supported and returns an error). Returns a JSON array of audit entries (text, enteredDate, enteredBy, auditType, auditSubType, auditSource). There is no system-wide / cross-record audit query in ConnectWise Manage. |
cw_list_callbacks |
Free | Read-only | [ConnectWise] List registered callback entries (webhooks) with optional filtering. Returns paginated callback records including URL, object type, and level. Use to audit which integrations receive event notifications from ConnectWise. |
cw_list_custom_reports |
Free | Read-only | [ConnectWise] List all custom reports configured in ConnectWise. Returns report IDs, names, and module references. Use to discover available custom reports for data analysis. |
cw_list_recent_audit_entries |
Free | Read-only | [ConnectWise] List recent audit-trail entries for ONE record from the last N days, most-recent first. ConnectWise scopes the audit trail per record and has no system-wide 'recent changes' feed, so you MUST supply the record type and id; the day-window filter and sort are applied on the StackJack side. Returns the matching audit entries as a JSON array. |
cw_list_security_roles |
Free | Read-only | [ConnectWise] List all security roles configured in ConnectWise. Returns role IDs, names, and admin flags. Use to understand the permission structure or validate role assignments. |
cw_list_standard_notes |
Free | Read-only | [ConnectWise] List all standard/canned notes configured in ConnectWise. Returns note IDs, names, and content. Use to discover pre-written note templates available for ticket notes, activities, and other records. |
cw_list_user_defined_fields |
Free | Read-only | [ConnectWise] List user-defined fields (UDFs) with optional filtering. Returns paginated UDF records including field name, caption, type, and entry method. Use to discover custom fields configured in the ConnectWise instance. |
cw_search_audit_trail |
Free | Read-only | [ConnectWise] Search the audit-trail history of ONE record. ConnectWise scopes the audit trail per record and offers no cross-record / global audit search, so you MUST supply the record type and id; the search text is matched (case-insensitive substring) against each entry's text and enteredBy fields on the StackJack side. Returns the matching audit entries as a JSON array. |
cw_search_user_defined_fields |
Free | Read-only | [ConnectWise] Search user-defined fields by caption or field name. Returns matching UDF records. Use this when you know the custom field name but want to find its details and ID. |
cw_count_callbacks parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
activeOnly |
boolean | no | false | Filter to active callbacks only (default false = all callbacks). |
cw_create_callback parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Callback fields as JSON. Required: {"url": "https://...", "objectId": N, "type": "ticket", "level": "owner"}. The URL must be HTTPS. |
cw_delete_callback parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric ConnectWise callback ID to delete. Verify with cw_list_callbacks before deleting. |
cw_list_active_callbacks parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_audit_trail parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | Optional ConnectWise conditions filter applied within this record's trail (advanced; leave empty for the full trail). |
id |
integer | yes | Numeric id of the record whose audit history to fetch (e.g. ticket number 1236718). | |
orderBy |
string | no | null | Optional orderBy, e.g. "enteredDate desc". |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
type |
string | yes | Record type. One of: Ticket, Contact, Company, Opportunity, Time, Activity, ProductCatalog, ProjectTicket, Purchasing, Configuration, Schedule, Agreement, AgreementAddition, Project, Invoice, PurchaseOrder, Expense, ProductItem, Survey, Member, PurchaseOrderLineItem, Site. |
cw_list_callbacks parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "type='ticket'", "url contains 'webhook'". Use '/' for nested fields, 'and'/'or' for boolean logic. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_list_recent_audit_entries parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
days |
integer | no | 7 | Number of days to look back (default 7). |
id |
integer | yes | Numeric id of the record whose recent audit history to list (e.g. ticket number 1236718). | |
type |
string | yes | Record type. One of: Ticket, Contact, Company, Opportunity, Time, Activity, ProductCatalog, ProjectTicket, Purchasing, Configuration, Schedule, Agreement, AgreementAddition, Project, Invoice, PurchaseOrder, Expense, ProductItem, Survey, Member, PurchaseOrderLineItem, Site. |
cw_list_user_defined_fields parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
conditions |
string | no | null | ConnectWise conditions filter. Examples: "caption contains 'Asset'", "entryMethod='EntryField'". Use '/' for nested fields, 'and'/'or' for boolean logic. |
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
cw_search_audit_trail parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | Numeric id of the record whose audit history to search (e.g. ticket number 1236718). | |
search |
string | yes | Search text matched (case-insensitive substring) against each entry's text or enteredBy. | |
type |
string | yes | Record type. One of: Ticket, Contact, Company, Opportunity, Time, Activity, ProductCatalog, ProjectTicket, Purchasing, Configuration, Schedule, Agreement, AgreementAddition, Project, Invoice, PurchaseOrder, Expense, ProductItem, Survey, Member, PurchaseOrderLineItem, Site. |
cw_search_user_defined_fields parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
page |
integer | no | 1 | Page number (default 1). |
pageSize |
integer | no | 50 | Results per page (default 50, max 200). |
search |
string | yes | Search text to match against UDF caption or field name. |
Analytics
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_board_performance_comparison |
Free | Read-only | [ConnectWise] Compare ticket metrics across service boards. Fetches open and recently closed tickets, groups by board, and computes volume and average resolution time per board. Use for identifying which boards are busiest or slowest. |
cw_first_response_time_analytics |
Free | Read-only | [ConnectWise] Measure first response times for tickets in a date range. Fetches tickets and their first note to compute average and median time-to-first-response. Use for SLA and responsiveness assessment. Makes 1+N API calls (1 for tickets + 1 per sampled ticket, default N=20). May be slow for large sample sizes. |
cw_open_ticket_age_distribution |
Free | Read-only | [ConnectWise] Analyze open tickets grouped by age bucket (0-7d, 8-14d, 15-30d, 31-60d, 60d+). Returns bucket names and ticket counts showing the age profile of open work. Use for backlog health assessment. |
cw_open_ticket_summary |
Free | Read-only | [ConnectWise] Quick summary of all open tickets grouped by board, priority, and age bucket. Use for a fast pulse-check on the service desk backlog. |
cw_priority_distribution |
Free | Read-only | [ConnectWise] Open ticket count per priority level. Returns a quick dashboard metric showing how open tickets are distributed across priority levels. Use for daily health checks and prioritization. |
cw_stale_ticket_report |
Free | Read-only | [ConnectWise] Identify open tickets with no activity beyond a threshold. Returns tickets sorted by days since last update. Use for daily triage. |
cw_team_workload_balance |
Free | Read-only | [ConnectWise] View open ticket distribution across members to identify workload imbalances. Returns per-member open ticket counts and workload percentages. Use for capacity planning or rebalancing assignments. Note: Makes 2 API calls internally. |
cw_ticket_aging_report |
Free | Read-only | [ConnectWise] Group open tickets by the week they were created. Shows intake vs resolution rate over time by counting how many tickets from each creation week remain open. Use for backlog trend analysis. |
cw_ticket_resolution_analytics |
Free | Read-only | [ConnectWise] Analyze resolution metrics for closed tickets in a date range. Returns average and median resolution time in hours, total closed count, and fastest/slowest resolution times. Use for service delivery performance review. |
cw_ticket_source_analysis |
Free | Read-only | [ConnectWise] Analyze ticket creation sources (email, phone, portal, etc.). Fetches tickets in a date range and groups by source to show which channels generate the most volume. Use for understanding intake patterns. |
cw_ticket_volume_trends |
Free | Read-only | [ConnectWise] Track ticket volume over multiple time periods to identify trends. Returns an array of period buckets with start/end dates and ticket counts. Use for weekly or monthly volume reporting. Note: Makes one API call per period. |
cw_unassigned_ticket_report |
Free | Read-only | [ConnectWise] Count and list unassigned open tickets grouped by board. Returns per-board counts and ticket summaries for tickets with no owner. Use for daily triage to ensure all tickets are assigned. |
cw_board_performance_comparison parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
days |
integer | no | 30 | Number of days to look back (default 30). |
pageSize |
integer | no | 200 | Maximum tickets to analyze (default 200, max 200). |
cw_first_response_time_analytics parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
endDate |
string | yes | End date in yyyy-MM-dd format. | |
sampleSize |
integer | no | 20 | Maximum tickets to sample for note fetching (default 20, max 50). |
startDate |
string | yes | Start date in yyyy-MM-dd format. |
cw_open_ticket_age_distribution parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize |
integer | no | 200 | Maximum tickets to analyze (default 200, max 200). Larger sets give more accurate distribution. |
cw_open_ticket_summary parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize |
integer | no | 200 | Maximum tickets to analyze (default 200, max 200). |
cw_priority_distribution parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize |
integer | no | 200 | Maximum tickets to analyze (default 200, max 200). |
cw_stale_ticket_report parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize |
integer | no | 50 | Maximum results (default 50, max 200). |
staleDays |
integer | no | 7 | Days of inactivity to consider stale (default 7). |
cw_team_workload_balance parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize |
integer | no | 200 | Maximum tickets to analyze (default 200, max 200). |
cw_ticket_aging_report parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize |
integer | no | 200 | Maximum tickets to analyze (default 200, max 200). |
cw_ticket_resolution_analytics parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
endDate |
string | yes | End date in yyyy-MM-dd format. Defines the end of the analysis period. | |
pageSize |
integer | no | 200 | Maximum tickets to analyze (default 200, max 200). |
startDate |
string | yes | Start date in yyyy-MM-dd format. Defines the beginning of the analysis period. |
cw_ticket_source_analysis parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
endDate |
string | no | null | End date in yyyy-MM-dd format (default: today). |
pageSize |
integer | no | 200 | Maximum tickets to analyze (default 200, max 200). |
startDate |
string | no | null | Start date in yyyy-MM-dd format (default: 30 days ago). |
cw_ticket_volume_trends parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
periodDays |
integer | no | 7 | Days per period (default 7). |
periods |
integer | no | 4 | Number of periods to analyze (default 4). |
cw_unassigned_ticket_report parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize |
integer | no | 200 | Maximum tickets to return (default 200, max 200). |
Advanced Analytics
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_agreement_coverage_gaps |
Pro | Read-only | [ConnectWise] Identify companies with open tickets but no active agreement. Cross-references companies with open tickets against companies with active (non-cancelled) agreements to find coverage gaps. Use for upselling agreement coverage. Note: Makes 2 API calls internally. |
cw_agreement_renewal_forecast |
Pro | Read-only | [ConnectWise] List agreements expiring within N days. Fetches active agreements and filters by end date to identify upcoming renewals. Use for renewal pipeline management and proactive customer outreach. |
cw_agreement_utilization_tracker |
Pro | Read-only | [ConnectWise] Track agreement hours used vs budgeted. Fetches agreements and associated time entries to calculate utilization percentage for each agreement. Returns per-agreement metrics showing hours consumed against budget. Note: Makes 2 API calls internally. |
cw_billing_leakage_detection |
Pro | Read-only | [ConnectWise] Find billable time and expenses not yet invoiced. Cross-references time entries with invoices to detect revenue leakage. Use for billing reconciliation before month-end close. Note: Makes 2 API calls internally. |
cw_cross_board_ticket_flow |
Pro | Read-only | [ConnectWise] Compare ticket volume and resolution across all boards. Identifies overloaded boards by showing open count, closed count, and average resolution hours per board. Use for capacity planning and board rebalancing. |
cw_csat_report |
Pro | Read-only | [ConnectWise] Customer satisfaction report based on service survey results. Fetches surveys and their results to calculate per-member and overall CSAT scores. Returns average scores, response counts, and per-member breakdowns. Makes 1+N API calls (1 for surveys + 1 per survey for results). |
cw_dispatch_optimizer |
Pro | Read-only | [ConnectWise] Workload-based dispatch suggestions for unassigned tickets. Analyzes open ticket distribution across active members and suggests assignments based on current capacity. Returns members ranked by available capacity with suggested ticket assignments. Note: Makes 2 API calls internally. |
cw_mean_time_metrics |
Pro | Read-only | [ConnectWise] Calculate MTTR (Mean Time To Resolve), MTTA (Mean Time To Acknowledge via first note), and MTBF (Mean Time Between Failures per company) for closed tickets in a date range. Use for operational KPI reporting. |
cw_member_utilization_report |
Pro | Read-only | [ConnectWise] Analyze member utilization showing billable vs total hours and utilization rate against a target. Returns per-member metrics for capacity planning and identifying under- or over-utilized staff. Note: Makes 2 API calls internally. |
cw_overdue_ticket_report |
Pro | Read-only | [ConnectWise] Tickets past their SLA resolution target. Compares open ticket age against SLA resolve hours and returns tickets that have exceeded their target, sorted by severity. Note: Makes 2 API calls internally. |
cw_project_burn_rate |
Pro | Read-only | [ConnectWise] Analyze project hours burned vs budgeted with projected completion. Fetches a project and its time entries to calculate burn rate and estimate remaining days. Note: Makes 2 API calls internally. |
cw_repeat_caller_analysis |
Pro | Read-only | [ConnectWise] Identify companies and contacts with the highest ticket volume. Fetches tickets in a date range, groups by company, and ranks by volume. Use for identifying frequent callers that may need proactive support or root-cause investigation. |
cw_resource_capacity_planning |
Pro | Read-only | [ConnectWise] Member availability vs scheduled work and open ticket assignments. Compares member count against scheduled entries and open ticket load to assess capacity. Note: Makes 3 API calls internally. |
cw_sla_compliance_dashboard |
Pro | Read-only | [ConnectWise] SLA compliance metrics for closed tickets in a date range. Returns compliance rates, breach counts, and near-miss counts based on SLA response and resolution targets. Use for management reporting and service quality assessment. Note: Makes 2-3 API calls internally. |
cw_ticket_category_trends |
Pro | Read-only | [ConnectWise] Track ticket type and subtype distribution over a date range. Fetches tickets and groups by type/subtype to show which issue categories are most common. Use for trend analysis and resource planning. |
cw_time_entry_anomaly_detection |
Pro | Read-only | [ConnectWise] Flag unusual time entries including entries over 12 hours, weekend entries, zero-hour entries, and potential duplicates. Use for time entry auditing and data quality checks. |
cw_timesheet_summary |
Pro | Read-only | [ConnectWise] Summarize time entries by member and company for a date range. Returns total hours, billable hours, and per-member/company breakdowns. Use for payroll review, billing reconciliation, or management reporting. |
cw_top_time_consumers |
Pro | Read-only | [ConnectWise] Members and companies with the most hours logged in a date range. Returns ranked lists of top time consumers by member and by company. Use for billing review and resource allocation analysis. |
cw_unbilled_time_report |
Pro | Read-only | [ConnectWise] Find billable time entries that have not been invoiced. Returns unbilled entries grouped by company with total hours and potential revenue at risk. Use for billing reconciliation and revenue recovery. |
cw_weekend_work_report |
Pro | Read-only | [ConnectWise] Time entries logged on weekends (Saturday and Sunday) in a date range. Returns per-member weekend hours and entry counts. Use for overtime tracking, work-life balance monitoring, or billing review. |
cw_agreement_coverage_gaps parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize |
integer | no | 200 | Maximum tickets to analyze (default 200, max 200). |
cw_agreement_renewal_forecast parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
days |
integer | no | 90 | Number of days to look ahead for expiring agreements (default 90). |
cw_agreement_utilization_tracker parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize |
integer | no | 200 | Maximum agreements to analyze (default 200, max 200). |
cw_billing_leakage_detection parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
endDate |
string | yes | End date in yyyy-MM-dd format. | |
startDate |
string | yes | Start date in yyyy-MM-dd format. |
cw_cross_board_ticket_flow parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize |
integer | no | 200 | Maximum tickets to analyze (default 200, max 200). |
cw_dispatch_optimizer parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize |
integer | no | 200 | Maximum tickets to analyze (default 200, max 200). |
cw_mean_time_metrics parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
endDate |
string | yes | End date in yyyy-MM-dd format. | |
pageSize |
integer | no | 200 | Maximum tickets to analyze (default 200, max 200). |
startDate |
string | yes | Start date in yyyy-MM-dd format. |
cw_member_utilization_report parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
endDate |
string | yes | End date in yyyy-MM-dd format. Defines the end of the analysis period. | |
startDate |
string | yes | Start date in yyyy-MM-dd format. Defines the beginning of the analysis period. | |
targetUtilization |
integer | no | 70 | Target utilization percentage (default 70). Members below this are flagged as under-utilized. |
cw_overdue_ticket_report parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize |
integer | no | 200 | Maximum tickets to analyze (default 200, max 200). |
cw_project_burn_rate parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
projectId |
integer | yes | The ConnectWise project ID to analyze. |
cw_repeat_caller_analysis parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
days |
integer | no | 90 | Number of days to look back (default 90). |
minTickets |
integer | no | 3 | Minimum tickets to be considered a repeat caller (default 3). |
pageSize |
integer | no | 200 | Maximum tickets to analyze (default 200, max 200). |
cw_resource_capacity_planning parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
days |
integer | no | 7 | Number of days ahead to check schedules (default 7). |
cw_sla_compliance_dashboard parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
endDate |
string | yes | End date in yyyy-MM-dd format. Defines the end of the analysis period. | |
pageSize |
integer | no | 200 | Maximum tickets to analyze (default 200, max 200). |
startDate |
string | yes | Start date in yyyy-MM-dd format. Defines the beginning of the analysis period. |
cw_ticket_category_trends parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
endDate |
string | yes | End date in yyyy-MM-dd format. | |
pageSize |
integer | no | 200 | Maximum tickets to analyze (default 200, max 200). |
startDate |
string | yes | Start date in yyyy-MM-dd format. |
cw_time_entry_anomaly_detection parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
days |
integer | no | 30 | Number of days to look back (default 30). |
cw_timesheet_summary parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
endDate |
string | yes | End date in yyyy-MM-dd format. Defines the end of the timesheet period. | |
startDate |
string | yes | Start date in yyyy-MM-dd format. Defines the beginning of the timesheet period. |
cw_top_time_consumers parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
endDate |
string | yes | End date in yyyy-MM-dd format. | |
startDate |
string | yes | Start date in yyyy-MM-dd format. | |
topN |
integer | no | 20 | Number of top results to return (default 20). |
cw_unbilled_time_report parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize |
integer | no | 200 | Maximum entries to analyze (default 200, max 200). |
cw_weekend_work_report parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
endDate |
string | yes | End date in yyyy-MM-dd format. | |
startDate |
string | yes | Start date in yyyy-MM-dd format. |
Premium Analytics
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_agreement_profitability_analysis |
Pro | Read-only | [ConnectWise] Analyze agreement profitability by comparing agreement revenue to labor cost from time entries. Returns revenue, estimated cost, margin, and effective hourly rate. Use to evaluate whether specific agreements are profitable. Note: Makes 2 API calls internally. |
cw_client_health_score |
Pro | Read-only | [ConnectWise] Composite client health score (0-100) based on ticket volume, resolution time, open ticket age, and agreement status. Returns an overall score with per-dimension breakdowns. Use to identify at-risk clients or prepare for QBR meetings. Note: Makes 3 API calls internally. |
cw_client_retention_analysis |
Pro | Read-only | [ConnectWise] Identify at-risk clients based on agreement expiry and declining ticket engagement. Flags companies with agreements ending soon or already expired, combined with low recent ticket activity. Note: Makes 2 API calls internally. |
cw_company_offboarding_audit |
Pro | Read-only | [ConnectWise] Check a company for open items before offboarding: open tickets, active agreements, open projects, and configurations. Returns a checklist of items that need resolution. Note: Makes 4 API calls internally. |
cw_customer_lifetime_value |
Pro | Read-only | [ConnectWise] Calculate total invoice revenue per company to estimate customer lifetime value. Ranks companies by total spend. Use for identifying top accounts and revenue concentration risk. |
cw_effective_hourly_rate |
Pro | Read-only | [ConnectWise] Calculate effective hourly rate by comparing invoiced revenue to hours logged. Returns actual rate, target variance, and per-company breakdowns. Use to assess overall service delivery profitability. Note: Makes 2 API calls internally. |
cw_monthly_recurring_revenue |
Pro | Read-only | [ConnectWise] Calculate MRR from active agreements with recurring billing. Fetches non-cancelled agreements and sums their recurring bill amounts. Returns total MRR, agreement count, and per-agreement breakdown. |
cw_pipeline_revenue_forecast |
Pro | Read-only | [ConnectWise] Weighted pipeline revenue forecast from open opportunities. Calculates expected revenue by multiplying each opportunity's value by its probability percentage. Returns per-stage and overall forecasts. Use for sales forecasting and pipeline reviews. |
cw_procurement_spend_analysis |
Pro | Read-only | [ConnectWise] Analyze purchase order spending by vendor and status. Fetches purchase orders and groups by vendor to show spending distribution. Use for vendor management and procurement optimization. |
cw_profitability_leaderboard |
Pro | Read-only | [ConnectWise] Rank companies by profitability (invoice revenue minus estimated time cost). Compares invoiced revenue against time logged at a given hourly cost rate. Returns per-company profit margins. Note: Makes 2 API calls internally. |
cw_project_portfolio_health |
Pro | Read-only | [ConnectWise] Project portfolio health dashboard comparing budget vs actual hours across active projects. Returns per-project metrics including budget utilization, overrun alerts, and overall portfolio status. Note: Makes 2 API calls internally. |
cw_qbr_data_pack |
Pro | Read-only | [ConnectWise] Comprehensive quarterly business review data pack for a client. Returns ticket volume and resolution metrics, time logged, agreement status, and configuration counts. Use to prepare QBR presentations. Note: Makes 4 API calls internally and may take several seconds. |
cw_revenue_per_employee |
Pro | Read-only | [ConnectWise] Calculate total invoiced revenue divided by active member count for a date range. Returns the revenue per employee metric. Use for profitability benchmarking. Note: Makes 2 API calls internally. |
cw_service_margin_analysis |
Pro | Read-only | [ConnectWise] Analyze revenue vs labor cost per company by comparing invoiced amounts to time entries at a cost rate. Returns margin and effective rate per company. Note: Makes 2 API calls internally. |
cw_agreement_profitability_analysis parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
agreementId |
integer | yes | The ConnectWise agreement ID to analyze. Use cw_list_agreements to find valid IDs. | |
hourlyRate |
number | no | 75 | Hourly cost rate for labor cost estimation (default 75.00). |
cw_client_health_score parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The ConnectWise company ID to analyze. Use cw_list_companies to find valid IDs. | |
lookbackDays |
integer | no | 90 | Number of days to look back for scoring (default 90). |
cw_client_retention_analysis parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
expiryWindowDays |
integer | no | 90 | Days ahead to check for expiring agreements (default 90). |
cw_company_offboarding_audit parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The ConnectWise company ID to audit for offboarding. |
cw_customer_lifetime_value parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize |
integer | no | 200 | Maximum invoices to analyze (default 200, max 200). |
cw_effective_hourly_rate parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
endDate |
string | yes | End date in yyyy-MM-dd format. Defines the end of the analysis period. | |
startDate |
string | yes | Start date in yyyy-MM-dd format. Defines the beginning of the analysis period. | |
targetRate |
number | yes | Target hourly rate for comparison (e.g. 150.00). The report shows variance against this target. |
cw_procurement_spend_analysis parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize |
integer | no | 200 | Maximum purchase orders to analyze (default 200, max 200). |
cw_profitability_leaderboard parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
endDate |
string | yes | End date in yyyy-MM-dd format. | |
hourlyRate |
number | no | 75 | Hourly cost rate for labor estimation (default 75.00). |
startDate |
string | yes | Start date in yyyy-MM-dd format. |
cw_qbr_data_pack parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The ConnectWise company ID to generate QBR data for. Use cw_list_companies to find valid IDs. | |
quarterEnd |
string | yes | Quarter end date in yyyy-MM-dd format (e.g. '2025-03-31' for Q1 2025). | |
quarterStart |
string | yes | Quarter start date in yyyy-MM-dd format (e.g. '2025-01-01' for Q1 2025). |
cw_revenue_per_employee parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
endDate |
string | yes | End date in yyyy-MM-dd format. | |
startDate |
string | yes | Start date in yyyy-MM-dd format. |
cw_service_margin_analysis parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
costRate |
number | no | 75 | Hourly cost rate for labor cost estimation (default 75.00). |
endDate |
string | yes | End date in yyyy-MM-dd format. | |
startDate |
string | yes | Start date in yyyy-MM-dd format. |
Cross-Domain
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_board_health_dashboard |
Pro | Read-only | [ConnectWise] Health metrics for a specific service board: open ticket count, average age, SLA compliance estimate, and top assignees. Use for board-level performance monitoring. Note: Makes 2 API calls internally. |
cw_bulk_status_summary |
Pro | Read-only | [ConnectWise] Counts of open items across all domains for a company: open tickets, active agreements, open projects, open opportunities, and configurations. Use for a quick company health snapshot. Note: Makes 5 API calls internally. |
cw_company_financial_summary |
Pro | Read-only | [ConnectWise] Total invoiced revenue, total hours logged, agreement value, and open ticket count for a company. Comprehensive financial overview in a single composite call. Note: Makes 4 API calls internally. |
cw_entity_relationship_map |
Pro | Read-only | [ConnectWise] Show relationships between a company's tickets, agreements, projects, opportunities, contacts, and configurations. Returns counts and summaries for each entity type linked to the company. Note: Makes 6 API calls internally. |
cw_new_client_onboarding_status |
Pro | Read-only | [ConnectWise] Check what's been set up for a new client: contacts, sites, configurations, and agreements. Returns counts and details for each category with an overall readiness score. Note: Makes 4 API calls internally. |
cw_technician_dashboard |
Pro | Read-only | [ConnectWise] Today's schedule entries, open assigned tickets, and time logged today for a specific member. Use for technician daily briefings or self-service dashboards. Note: Makes 3 API calls internally. |
cw_ticket_handoff_analysis |
Pro | Read-only | [ConnectWise] Analyze resolution patterns for closed tickets, identifying tickets with unusually long resolution times and board distribution. Note: Does not detect individual reassignment events. |
cw_weekly_operations_report |
Pro | Read-only | [ConnectWise] Tickets opened and closed this week, time logged, and tickets approaching SLA breach. Provides a weekly operations snapshot for management review. Note: Makes 3 API calls internally. |
cw_board_health_dashboard parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
boardId |
integer | yes | The numeric ConnectWise service board ID. Use cw_list_service_boards to find valid IDs. |
cw_bulk_status_summary parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The ConnectWise company ID to summarize. |
cw_company_financial_summary parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The numeric ConnectWise company ID. |
cw_entity_relationship_map parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The ConnectWise company ID to map relationships for. |
cw_new_client_onboarding_status parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The numeric ConnectWise company ID. |
cw_technician_dashboard parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
memberId |
integer | yes | The ConnectWise member ID to build a dashboard for. |
cw_ticket_handoff_analysis parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
days |
integer | no | 30 | Number of days to look back (default 30). |
pageSize |
integer | no | 200 | Maximum tickets to analyze (default 200, max 200). |
Intelligence
| Tool | Plan | Access | Description |
|---|---|---|---|
cw_after_hours_impact_report |
Pro | Read-only | [ConnectWise] Analyze tickets and time logged outside standard business hours (before 8 AM or after 6 PM, and weekends). Returns after-hours time entries grouped by member and day of week. Use for overtime analysis and staffing decisions. |
cw_company_360_view |
Pro | Read-only | [ConnectWise] Comprehensive 360-degree view of a company. Fetches company details, open tickets, active agreements, contacts, and configurations in a single composite call. Use for account reviews or before customer calls. Note: Makes 5 API calls internally. |
cw_company_onboarding_checklist |
Pro | Read-only | [ConnectWise] Evaluate onboarding completeness for a company. Checks for presence of contacts, configurations, agreements, site information, and recent tickets to build an onboarding checklist with completion status. Note: Makes 5 API calls internally. |
cw_company_risk_assessment |
Pro | Read-only | [ConnectWise] Churn risk score (0-100) for a company based on ticket trends, SLA compliance, and agreement status. A higher score indicates greater churn risk. Returns the overall risk score with per-dimension breakdowns. Note: Makes 3 API calls internally. |
cw_configuration_lifecycle_tracker |
Pro | Read-only | [ConnectWise] Assets approaching warranty expiry or with high ticket correlation. Identifies configurations nearing end of warranty and those generating the most tickets. Note: Makes 2 API calls internally. |
cw_daily_operations_briefing |
Pro | Read-only | [ConnectWise] Daily operations summary including new tickets (last 24h), SLA warning tickets (open > 4 hours), stale tickets (no update in 7+ days), and unassigned queue. Use for morning standup or shift handoff. Note: Makes 4 API calls internally. |
cw_escalation_risk_scorer |
Pro | Read-only | [ConnectWise] Score open tickets by escalation risk based on age, priority, SLA status, and assignment. Returns a ranked list of tickets most likely to escalate. Use for proactive service management. |
cw_knowledge_article_recommendation |
Pro | Read-only | [ConnectWise] Given a ticket ID, find knowledge base articles with matching keywords. Fetches the ticket summary and searches KB articles for relevant matches. Use for suggesting solutions to technicians. Note: Makes 2 API calls internally. |
cw_proactive_maintenance_alerts |
Pro | Read-only | [ConnectWise] Configurations with recent tickets suggesting maintenance needs. Fetches active configurations and correlates with recent tickets to identify assets generating repeated issues. Note: Makes 2 API calls internally. |
cw_recurring_issue_detector |
Pro | Read-only | [ConnectWise] Detect recurring issues by grouping tickets by company and type/subtype. Identifies patterns where the same issue type recurs for a company beyond a minimum occurrence threshold. Use to identify systemic problems that need permanent resolution. |
cw_resource_skill_matcher |
Pro | Read-only | [ConnectWise] Given a ticket, find members whose skills match the ticket type/subtype. Fetches the ticket details and active member skills to suggest the best-fit assignee. Note: Makes 2 API calls internally. |
cw_revenue_leakage_scan |
Pro | Read-only | [ConnectWise] Identify potential revenue leakage: billable time entries not yet invoiced, and zero-hour entries that may indicate logging errors. Returns uninvoiced billable entries grouped by company plus zero-value time entries. Note: Makes 2 API calls internally. |
cw_schedule_gap_analysis |
Pro | Read-only | [ConnectWise] Find unscheduled time blocks for members by comparing schedule entries against a workday. Returns members with the most available (unscheduled) time. Note: Makes 2 API calls internally. |
cw_similar_ticket_finder |
Pro | Read-only | [ConnectWise] Find tickets with similar summaries to a given ticket. Fetches the ticket, extracts keywords, and searches for matching closed tickets. Use for finding prior resolutions to similar issues. Note: Makes 2 API calls internally. |
cw_sla_breach_alerts |
Pro | Read-only | [ConnectWise] Identify open tickets at risk of SLA breach. Compares open ticket age against SLA resolution targets and flags tickets that have exceeded or are approaching (>80%) their SLA window. Note: Makes 2 API calls internally. |
cw_ticket_triage_assist |
Pro | Read-only | [ConnectWise] Triage assistance for a ticket. Fetches the ticket details, finds similar resolved tickets (by summary keyword matching), and lists member skills to suggest an assignee. Returns the ticket, up to 5 similar resolved tickets, and available member skills. Note: Makes 3 API calls internally. |
cw_time_prediction_model |
Pro | Read-only | [ConnectWise] Based on similar past tickets (by type/subtype), estimate time to resolve. Fetches the ticket details and finds resolved tickets of the same type, then computes average actual hours. Note: Makes 2 API calls internally. |
cw_after_hours_impact_report parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
businessEnd |
integer | no | 18 | Business hours end (default 18, meaning 6 PM). |
businessStart |
integer | no | 8 | Business hours start (default 8, meaning 8 AM). |
days |
integer | no | 30 | Number of days to look back (default 30). |
cw_company_360_view parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The numeric ConnectWise company ID. |
cw_company_onboarding_checklist parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The numeric ConnectWise company ID. |
cw_company_risk_assessment parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The numeric ConnectWise company ID. |
cw_configuration_lifecycle_tracker parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
warrantyWindowDays |
integer | no | 90 | Days ahead to check for warranty expiry (default 90). |
cw_escalation_risk_scorer parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize |
integer | no | 200 | Maximum tickets to analyze (default 200, max 200). |
cw_knowledge_article_recommendation parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
ticketId |
integer | yes | The numeric ConnectWise ticket ID to find KB articles for. |
cw_proactive_maintenance_alerts parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
days |
integer | no | 30 | Days to look back for ticket correlation (default 30). |
minTickets |
integer | no | 2 | Minimum tickets per config to flag (default 2). |
cw_recurring_issue_detector parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
days |
integer | no | 90 | Number of days to look back (default 90). |
minOccurrences |
integer | no | 3 | Minimum number of occurrences to flag as recurring (default 3). |
cw_resource_skill_matcher parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
ticketId |
integer | yes | The numeric ConnectWise ticket ID to match skills for. |
cw_schedule_gap_analysis parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
days |
integer | no | 5 | Number of days ahead to analyze (default 5). |
workHoursPerDay |
integer | no | 8 | Expected work hours per day (default 8). |
cw_similar_ticket_finder parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
maxResults |
integer | no | 10 | Maximum similar tickets to return (default 10). |
ticketId |
integer | yes | The numeric ConnectWise ticket ID to find similar tickets for. |
cw_ticket_triage_assist parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
ticketId |
integer | yes | The numeric ConnectWise ticket ID to triage. |
cw_time_prediction_model parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
ticketId |
integer | yes | The numeric ConnectWise ticket ID to predict time for. |