Query ConnectWise Configurations
The Query ConnectWise Configurations action searches for configurations in ConnectWise Manage. A configuration represents an item that a company uses or owns, such as a server, workstation, network device, software installation, or managed asset. This single API call action returns configurations that match your query.
This is a single API call action. You define the query conditions and the action makes one API call to retrieve the results. Learn more about the difference between workflow actions and single API call actions.
When to Use This Action
Use this action when:
- You need to find a configuration by name, serial number, tag number, or device identifier
- You want to list configurations for a specific ConnectWise company
- You need configuration details for a later workflow action
- You want to check a configuration's status, type, warranty date, or active state
Do not use this action to search for service tickets. Use Query ConnectWise Tickets instead.
How It Works
- The action builds filters from the standard, child, and custom field conditions you configure.
- It sends one request to the ConnectWise Manage Configurations endpoint.
- It stores either the first matching configuration or the full returned page, based on Return all results.
Configuration
Connection
| Field | Description |
|---|---|
| ConnectWise Connection | Select the ConnectWise connection to use. |
Query Conditions
Use the query builder to filter standard configuration fields. Common fields include:
For Configuration ID, Type ID, Status ID, Company ID, Contact ID, Parent Configuration ID, Installed By ID, Vendor ID, Manufacturer ID, and SLA ID, select a matching ConnectWise record from the list. Select the unlock button when you need a dynamic value, such as a text expression from earlier workflow data.
Configuration details:
- ID, Name, Type, Status, Active, Device Identifier, Serial Number, Model Number, Tag Number
Company details:
- Company, Contact, Site, Location, Business Unit
Hardware and network details:
- Manufacturer, Vendor, MAC Address, IP Address, Default Gateway, Operating System, CPU Speed, RAM
Dates:
- Purchase Date, Installation Date, Warranty Expiration Date, Last Backup Date
Management details:
- Management Link, Remote Link, SLA, Parent Configuration
Child Conditions
Use child conditions to filter related configuration records, such as configuration questions. Conditions in this section apply to the same related record.
Custom Field Conditions
Use custom field conditions to filter ConnectWise configuration custom fields. Match fields by properties such as caption and value.
Query Options
| Field | Description |
|---|---|
| Order By | Enter a ConnectWise field and direction, such as name asc or warrantyExpirationDate desc. |
| Fields | Enter a comma-separated list of fields to return, such as id,name,type,status,company. Leave blank to return the full configuration objects. |
Pagination
| Field | Description |
|---|---|
| Page Size | Number of results per page (1-1000). Default: 25. |
| Page | Page number to retrieve. Default: 1. |
| Return all results | When enabled, returns the full array from the requested page. When disabled, returns only the first matching configuration. |
Error Handling
| Field | Description |
|---|---|
| Error Handling | Select what the workflow should do if ConnectWise rejects the query or cannot complete the request. |
Returned Variables
When you configure Store the results in Variable:
When "Return all results" is disabled: The variable contains the first matching configuration object.
If no configuration matches, the variable contains null.
When "Return all results" is enabled: The variable contains an array of configuration objects from the requested page.
Configuration Object Properties
ConnectWise returns the fields selected in Fields, or the complete configuration object when that field is blank. Common properties include:
| Property | Type | Description |
|---|---|---|
id | number | ConnectWise configuration ID |
name | string | Configuration name |
type | object | Configuration type (id, name) |
status | object | Configuration status (id, name) |
company | object | Associated company (id, identifier, name) |
contact | object | Associated contact |
site | object | Associated company site |
deviceIdentifier | string | Device identifier or hostname |
serialNumber | string | Serial number |
modelNumber | string | Model number |
tagNumber | string | Asset tag number |
activeFlag | boolean | Whether the configuration is active |
warrantyExpirationDate | string | Warranty expiration date |
manufacturer | object | Manufacturer details |
vendor | object | Vendor company details |
ipAddress | string | IP address |
macAddress | string | MAC address |
customFields | array | ConnectWise custom field values |
Example Use Cases
Find a Configuration by Serial Number
| Setting | Value |
|---|---|
| Query Condition | serialNumber equals {{custom.serialNumber}} |
| Return all results | Disabled |
List Active Configurations for a Company
| Setting | Value |
|---|---|
| Query Conditions | company/id equals {{custom.company.id}} AND activeFlag equals true |
| Order By | name asc |
| Return all results | Enabled |
Find Configurations with Expiring Warranties
| Setting | Value |
|---|---|
| Query Conditions | activeFlag equals true AND warrantyExpirationDate less than or equal to {{custom.warrantyCutoff}} |
| Order By | warrantyExpirationDate asc |
| Return all results | Enabled |
FAQs
Why did the action return only one configuration?
Enable Return all results to store the full array returned for the requested page. The default behavior stores only the first match.
How do I limit the response to a few properties?
Enter a comma-separated list in Fields. For example, use id,name,serialNumber,company to reduce the returned data.
Can I query ConnectWise configuration custom fields?
Yes. Add conditions in Custom Field Conditions. Use the custom field caption to identify the field and its value to select matching configurations.
Related Actions
- Query ConnectWise Companies: Find the company associated with a configuration
- Query ConnectWise Contacts: Find contacts at the associated company
- Query ConnectWise Tickets: Find service tickets related to a company