--- title: Kaseya Virtual System Administrator slug: connectors/kaseya-virtual-system-administrator docTags: createdAt: 2026-06-09T16:29:40.167Z --- This Connector integrates Kaseya Virtual System Administrator with Swimlane ## Capabilities This connector provides the following capabilities: - Add Organization - Get Agent Procedures - Get Agent Settings - Get Agent - Get Agents - Get Asset Types - Get Asset - Get Assets - Get Organization - Get Organizations - Get Scheduled Agent Procedure - Run Agent Procedure - Schedule Agent Procedure - Update Organization ## Asset Setup This connector supports the Token based Authentication. All applications follow a basic pattern when accessing a VSA API using OAuth 2.0. At a high level, you follow five steps: 1. Obtain OAuth 2.0 credentials from the VSA Server by registering your application. 2. Authenticate to the VSA to obtain a temporary authorization code. 3. Exchange the authorization code for an access token. 4. Send the access token to the VSA API when needed. 5. Refresh your access token, if necessary. For more details on the authentication, please refer to [Kaseya VSA Link](https://help.kaseya.com/webhelp/EN/RESTAPI/9050000/UsingOAuth2.0toAccessVSAAPIs.pdf#zoom=70\&navpanes=0) ## Notes For further details, please refer to [API Documentation](https://help.kaseya.com/webhelp/EN/restapi/9050000/#home.htm) # Configurations ## HTTP Bearer Authentication Authenticates using bearer token such as a JWT, etc. ### Configuration Parameters | **Parameter** | **Description** | **Type** | **Required** | | ------------- | ---------------------------------- | -------- | ------------ | | url | A URL to the target host. | string | Required | | token | The API key, token, etc. | string | Required | | verify\_ssl | Verify SSL certificate | boolean | Optional | | http\_proxy | A proxy to route requests through. | string | Optional | # Actions ## Add Organization This action adds a single organization record. ### Endpoint - **URL:** `/system/orgs` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ------------------------------------- | -------- | ------------ | ------------------------------ | | `OrgId` | number | Optional | Unique identifier | | `OrgName` | string | Optional | Name of the resource | | `OrgRef` | string | Optional | Parameter for Add Organization | | `OrgType` | string | Optional | Type of the resource | | `DefaultDepartmentName` | string | Optional | Name of the resource | | `DefaultMachineGroupName` | string | Optional | Name of the resource | | `ParentOrgId` | number | Optional | Unique identifier | | `Website` | string | Optional | Parameter for Add Organization | | `NoOfEmployees` | number | Optional | Parameter for Add Organization | | `AnnualRevenue` | number | Optional | Parameter for Add Organization | | `ContactInfo` | object | Optional | Parameter for Add Organization | | `ContactInfo.PreferredContactMethod` | string | Optional | HTTP method to use | | `ContactInfo.PrimaryPhone` | string | Optional | Parameter for Add Organization | | `ContactInfo.PrimaryFax` | string | Optional | Parameter for Add Organization | | `ContactInfo.PrimaryEmail` | string | Optional | Parameter for Add Organization | | `ContactInfo.Country` | string | Optional | Parameter for Add Organization | | `ContactInfo.Street` | string | Optional | Parameter for Add Organization | | `ContactInfo.City` | string | Optional | Parameter for Add Organization | | `ContactInfo.State` | string | Optional | Parameter for Add Organization | | `ContactInfo.ZipCode` | string | Optional | Parameter for Add Organization | | `ContactInfo.PrimaryTextMessagePhone` | string | Optional | Response message | | `CustomFields` | array | Optional | Parameter for Add Organization | | `CustomFields.FieldName` | string | Optional | Name of the resource | | `CustomFields.FieldValue` | string | Optional | Value for the parameter | | `Attributes` | object | Optional | Parameter for Add Organization | ### Input Example `{"json_body":{"OrgId":0,"OrgName":"string","OrgRef":"string","OrgType":"string","DefaultDepartmentName":"string","DefaultMachineGroupName":"string","ParentOrgId":0,"Website":"string","NoOfEmployees":0,"AnnualRevenue":0,"ContactInfo":{"PreferredContactMethod":"string","PrimaryPhone":"string","PrimaryFax":"string","PrimaryEmail":"string","Country":"string","Street":"string","City":"string","State":"string","ZipCode":"string","PrimaryTextMessagePhone":"string"},"CustomFields":[{"FieldName":"string","FieldValue":"string"}],"Attributes":{}}}` ### Output | **Parameter** | **Type** | **Description** | | -------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `ResponseCode` | number | Output field: ResponseCode | | `Status` | string | Status value | | `Error` | string | Error message if any | ### Output Example `{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"ResponseCode":200,"Status":"OK","Error":"None"}}` ## Get Agent This action returns a single agent record. ### Endpoint - **URL:** `/assetmgmt/agents/{{agentId}}` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ------------------------- | -------- | ------------ | ----------------------------------- | | `path_parameters.agentId` | number | Required | Parameters for the Get Agent action | ### Input Example `{"path_parameters":{"agentId":0}}` ### Output | **Parameter** | **Type** | **Description** | | ------------------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `Result` | object | Result of the operation | | `Result.AgentId` | number | Unique identifier | | `Result.AgentName` | string | Name of the resource | | `Result.Online` | number | Result of the operation | | `Result.OSType` | string | Type of the resource | | `Result.OSInfo` | string | Result of the operation | | `Result.OrgId` | number | Unique identifier | | `Result.MachineGroupId` | number | Unique identifier | | `Result.MachineGroup` | string | Result of the operation | | `Result.ComputerName` | string | Name of the resource | | `Result.IPv6Address` | string | Result of the operation | | `Result.IPAddress` | string | Result of the operation | | `Result.OperatingSystem` | string | Result of the operation | | `Result.OSVersion` | string | Result of the operation | | `Result.LastLoggedInUser` | string | Result of the operation | | `Result.LastRebootTime` | string | Result of the operation | | `Result.LastCheckInTime` | string | Result of the operation | | `Result.Country` | string | Result of the operation | | `Result.CurrentUser` | string | Result of the operation | | `Result.Contact` | string | Result of the operation | | `Result.TimeZone` | string | Result of the operation | | `Result.RamMBytes` | number | Result of the operation | | `Result.CpuCount` | number | Result of the operation | ### Output Example `{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"Result":{"AgentId":0,"AgentName":"string","Online":0,"OSType":"string","OSInfo":"string","OrgId":0,"MachineGroupId":0,"MachineGroup":"string","ComputerName":"string","IPv6Address":"string","IPAddress":"string","OperatingSystem":"string","OSVersion":"string","LastLoggedInUser":"string","LastRebootTime":"2016-02-02T17:55:17.030Z"},"ResponseCode":0,"Status":"string","Error":"string"}}` ## Get Agent Procedures This action returns an array of agent procedures. ### Endpoint - **URL:** `/automation/agentprocs` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | ---------------------------------------------- | | `parameters.filter` | string | Optional | Parameters for the Get Agent Procedures action | | `parameters.orderby` | string | Optional | Parameters for the Get Agent Procedures action | ### Input Example `{"parameters":{"filter":"substringof('cab', OrgName)","orderby":"Priority"}}` ### Output | **Parameter** | **Type** | **Description** | | --------------------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `TotalRecords` | number | Output field: TotalRecords | | `Result` | array | Result of the operation | | `Result.AgentProcedureId` | number | Unique identifier | | `Result.AgentProcedureName` | string | Name of the resource | | `Result.Path` | string | Result of the operation | | `Result.Description` | string | Result of the operation | | `Result.Attributes` | object | Result of the operation | | `ResponseCode` | number | Output field: ResponseCode | | `Status` | string | Status value | | `Error` | string | Error message if any | ### Output Example `{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"TotalRecords":0,"Result":[{}],"ResponseCode":0,"Status":"string","Error":"string"}}` ## Get Agent Settings This action returns an array of settings for an agent. ### Endpoint - **URL:** `/assetmgmt/agent/{{agentId}}/settings` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ------------------------- | -------- | ------------ | -------------------------------------------- | | `path_parameters.agentId` | number | Required | Parameters for the Get Agent Settings action | | `parameters.filter` | string | Optional | Parameters for the Get Agent Settings action | | `parameters.orderby` | string | Optional | Parameters for the Get Agent Settings action | ### Input Example `{"parameters":{"filter":"substringof('cab', OrgName)","orderby":"Priority"},"path_parameters":{"agentId":0}}` ### Output | **Parameter** | **Type** | **Description** | | ------------------------------------------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `Result` | object | Result of the operation | | `Result.AgentVersion` | number | Result of the operation | | `Result.CurrentUser` | string | Result of the operation | | `Result.LastCheckIn` | string | Result of the operation | | `Result.FirstCheckIn` | string | Result of the operation | | `Result.LastReboot` | string | Result of the operation | | `Result.TempDirectory` | string | Result of the operation | | `Result.CheckInControl` | object | Result of the operation | | `Result.CheckInControl.PrimaryKServer` | string | Result of the operation | | `Result.CheckInControl.PrimaryKServerPort` | number | Result of the operation | | `Result.CheckInControl.SecondaryKServer` | string | Result of the operation | | `Result.CheckInControl.SecondaryKServerPort` | number | Result of the operation | | `Result.CheckInControl.QuickCheckInTimeInSeconds` | number | Result of the operation | | `Result.CheckInControl.BandwidthThrottle` | number | Unique identifier | | `Result.CheckInControl.Attributes` | object | Result of the operation | | `Result.UserProfile` | object | Result of the operation | | `Result.UserProfile.AdminEmail` | string | Result of the operation | | `Result.UserProfile.UserName` | string | Name of the resource | | `Result.UserProfile.UserEmail` | string | Result of the operation | | `Result.UserProfile.UserPhone` | string | Result of the operation | | `Result.UserProfile.Notes` | string | Result of the operation | | `Result.UserProfile.ShowToolTip` | number | Result of the operation | | `Result.UserProfile.AutoAssignTickets` | boolean | Result of the operation | ### Output Example `{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"Result":{"AgentVersion":0,"CurrentUser":"string","LastCheckIn":"2016-03-16T16:13:52.579Z","FirstCheckIn":"2016-03-16T16:13:52.579Z","LastReboot":"2016-03-16T16:13:52.579Z","TempDirectory":"string","CheckInControl":{},"UserProfile":{},"PatchPolicyMembership":[],"ViewDefinitionCollections":[],"Attributes":{}},"ResponseCode":0,"Status":"string","Error":"string"}}` ## Get Agents This action returns an array of agent records. ### Endpoint - **URL:** `/assetmgmt/agents` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | ------------------------------------ | | `parameters.filter` | string | Optional | Parameters for the Get Agents action | | `parameters.orderby` | string | Optional | Parameters for the Get Agents action | ### Input Example `{"parameters":{"filter":"substringof('cab', OrgName)","orderby":"Priority"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `TotalRecords` | number | Output field: TotalRecords | | `Result` | array | Result of the operation | | `Result.AgentId` | number | Unique identifier | | `Result.AgentName` | string | Name of the resource | | `Result.Online` | number | Result of the operation | | `Result.OSType` | string | Type of the resource | | `Result.OSInfo` | string | Result of the operation | | `Result.OrgId` | number | Unique identifier | | `Result.MachineGroupId` | number | Unique identifier | | `Result.MachineGroup` | string | Result of the operation | | `Result.ComputerName` | string | Name of the resource | | `Result.IPv6Address` | string | Result of the operation | | `Result.IPAddress` | string | Result of the operation | | `Result.OperatingSystem` | string | Result of the operation | | `Result.OSVersion` | string | Result of the operation | | `Result.LastLoggedInUser` | string | Result of the operation | | `Result.LastRebootTime` | string | Result of the operation | | `Result.LastCheckInTime` | string | Result of the operation | | `Result.Country` | string | Result of the operation | | `Result.CurrentUser` | string | Result of the operation | | `Result.Contact` | string | Result of the operation | | `Result.TimeZone` | string | Result of the operation | | `Result.RamMBytes` | number | Result of the operation | ### Output Example `{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"TotalRecords":0,"Result":[{}],"ResponseCode":0,"Status":"string","Error":"string"}}` ## Get Asset This action returns a single detailed asset record. ### Endpoint - **URL:** `/assetmgmt/assets/{{assetId}}` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ------------------------- | -------- | ------------ | ----------------------------------- | | `path_parameters.assetId` | number | Required | Parameters for the Get Asset action | ### Input Example `{"path_parameters":{"assetId":0}}` ### Output | **Parameter** | **Type** | **Description** | | ---------------------------------------------- | -------- | ---------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `AssetId` | number | Unique identifier | | `AssetName` | string | Name of the resource | | `AssetTypeId` | number | Unique identifier | | `MachineGroupId` | number | Unique identifier | | `MachineGroup` | string | Output field: MachineGroup | | `OrgId` | number | Unique identifier | | `AgentId` | number | Unique identifier | | `DeviceId` | number | Unique identifier | | `DeviceName` | string | Name of the resource | | `DeviceType` | number | Type of the resource | | `DeviceTime` | string | Time value | | `ServerTime` | string | Time value | | `DeviceFounds` | array | Output field: DeviceFounds | | `DeviceFounds.DeviceId` | number | Unique identifier | | `DeviceFounds.FoundOn` | string | Output field: DeviceFounds.FoundOn | | `DeviceFounds.FoundBy` | object | Output field: DeviceFounds.FoundBy | | `DeviceFounds.FoundBy.ProbeId` | number | Unique identifier | | `DeviceFounds.FoundBy.ProbeTypeId` | number | Unique identifier | | `DeviceFounds.FoundBy.ProbeName` | string | Name of the resource | | `DeviceFounds.FoundBy.ProbeAgentId` | number | Unique identifier | | `DeviceFounds.FoundBy.ProbeType` | object | Type of the resource | | `DeviceFounds.FoundBy.ProbeType.ProbeTypeId` | number | Unique identifier | | `DeviceFounds.FoundBy.ProbeType.ProbeTypeName` | string | Name of the resource | ### Output Example `{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"AssetId":0,"AssetName":"string","AssetTypeId":0,"MachineGroupId":0,"MachineGroup":"string","OrgId":0,"AgentId":0,"DeviceId":0,"DeviceName":"string","DeviceType":0,"DeviceTime":"2016-02-02T22:50:04.298Z","ServerTime":"2016-02-02T22:50:04.298Z","DeviceFounds":[{}],"Attributes":{}}}` ## Get Asset Types This action returns an array of asset type records. ### Endpoint - **URL:** `/assetmgmt/assettypes` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | ----------------------------------------- | | `parameters.filter` | string | Optional | Parameters for the Get Asset Types action | | `parameters.orderby` | string | Optional | Parameters for the Get Asset Types action | ### Input Example `{"parameters":{"filter":"substringof('cab', OrgName)","orderby":"Priority"}}` ### Output | **Parameter** | **Type** | **Description** | | -------------------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `TotalRecords` | number | Output field: TotalRecords | | `Result` | array | Result of the operation | | `Result.AssetTypeId` | number | Unique identifier | | `Result.AssetTypeName` | string | Name of the resource | | `Result.ParentAssetTypeId` | number | Unique identifier | | `Result.Attributes` | object | Result of the operation | | `ResponseCode` | number | Output field: ResponseCode | | `Status` | string | Status value | | `Error` | string | Error message if any | ### Output Example `{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"TotalRecords":0,"Result":[{}],"ResponseCode":0,"Status":"string","Error":"string"}}` ## Get Assets This action returns an array of summary asset records. ### Endpoint - **URL:** `/assetmgmt/assets` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | ------------------------------------ | | `parameters.filter` | string | Optional | Parameters for the Get Assets action | | `parameters.orderby` | string | Optional | Parameters for the Get Assets action | ### Input Example `{"parameters":{"filter":"substringof('cab', OrgName)","orderby":"Priority"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------------------ | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `TotalRecords` | number | Output field: TotalRecords | | `Result` | array | Result of the operation | | `Result.AssetId` | number | Unique identifier | | `Result.AssetName` | string | Name of the resource | | `Result.AssetTypeId` | number | Unique identifier | | `Result.ProbeId` | number | Unique identifier | | `Result.MachineGroupId` | number | Unique identifier | | `Result.MachineGroup` | string | Result of the operation | | `Result.OrgId` | number | Unique identifier | | `Result.IsComputerAgent` | boolean | Result of the operation | | `Result.IsMobileAgent` | boolean | Result of the operation | | `Result.IsMonitoring` | string | Result of the operation | | `Result.IsPatching` | string | Result of the operation | | `Result.IsAuditing` | string | Result of the operation | | `Result.IsBackingUp` | string | Result of the operation | | `Result.IsSecurity` | string | Result of the operation | | `Result.TicketCount` | number | Result of the operation | | `Result.AlarmCount` | number | Result of the operation | | `Result.IsSNMPActive` | boolean | Result of the operation | | `Result.IsVProActive` | boolean | Result of the operation | | `Result.NetworkInfo` | number | Result of the operation | | `Result.AgentId` | number | Unique identifier | | `Result.DisplayName` | string | Name of the resource | ### Output Example `{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"TotalRecords":1.8,"Result":[{}],"ResponseCode":0,"Status":"string","Error":"string"}}` ## Get Organization This action returns a single organization record. ### Endpoint - **URL:** `/system/orgs/{{orgId}}` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------------- | -------- | ------------ | ------------------------------------------ | | `path_parameters.orgId` | number | Required | Parameters for the Get Organization action | ### Input Example `{"path_parameters":{"orgId":0}}` ### Output | **Parameter** | **Type** | **Description** | | ------------------------------------- | -------- | -------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `OrgId` | number | Unique identifier | | `OrgName` | string | Name of the resource | | `OrgRef` | string | Output field: OrgRef | | `OrgType` | string | Type of the resource | | `DefaultDepartmentName` | string | Name of the resource | | `DefaultMachineGroupName` | string | Name of the resource | | `ParentOrgId` | number | Unique identifier | | `Website` | string | Output field: Website | | `NoOfEmployees` | number | Output field: NoOfEmployees | | `AnnualRevenue` | number | Output field: AnnualRevenue | | `ContactInfo` | object | Output field: ContactInfo | | `ContactInfo.PreferredContactMethod` | string | HTTP method to use | | `ContactInfo.PrimaryPhone` | string | Output field: ContactInfo.PrimaryPhone | | `ContactInfo.PrimaryFax` | string | Output field: ContactInfo.PrimaryFax | | `ContactInfo.PrimaryEmail` | string | Output field: ContactInfo.PrimaryEmail | | `ContactInfo.Country` | string | Output field: ContactInfo.Country | | `ContactInfo.Street` | string | Output field: ContactInfo.Street | | `ContactInfo.City` | string | Output field: ContactInfo.City | | `ContactInfo.State` | string | Output field: ContactInfo.State | | `ContactInfo.ZipCode` | string | Output field: ContactInfo.ZipCode | | `ContactInfo.PrimaryTextMessagePhone` | string | Response message | | `CustomFields` | array | Output field: CustomFields | | `CustomFields.FieldName` | string | Name of the resource | ### Output Example `{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"OrgId":0,"OrgName":"string","OrgRef":"string","OrgType":"string","DefaultDepartmentName":"string","DefaultMachineGroupName":"string","ParentOrgId":0,"Website":"string","NoOfEmployees":0,"AnnualRevenue":0,"ContactInfo":{"PreferredContactMethod":"string","PrimaryPhone":"string","PrimaryFax":"string","PrimaryEmail":"string","Country":"string","Street":"string","City":"string","State":"string","ZipCode":"string","PrimaryTextMessage...` ## Get Organizations This action returns an array of organization records. ### Endpoint - **URL:** `/system/orgs` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | ------------------------------------------- | | `parameters.filter` | string | Optional | Parameters for the Get Organizations action | | `parameters.orderby` | string | Optional | Parameters for the Get Organizations action | ### Input Example `{"parameters":{"filter":"substringof('cab', OrgName)","orderby":"Priority"}}` ### Output | **Parameter** | **Type** | **Description** | | -------------------------------------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `TotalRecords` | number | Output field: TotalRecords | | `Result` | array | Result of the operation | | `Result.OrgId` | number | Unique identifier | | `Result.OrgName` | string | Name of the resource | | `Result.OrgRef` | string | Result of the operation | | `Result.OrgType` | string | Type of the resource | | `Result.DefaultDepartmentName` | string | Name of the resource | | `Result.DefaultMachineGroupName` | string | Name of the resource | | `Result.ParentOrgId` | number | Unique identifier | | `Result.Website` | string | Result of the operation | | `Result.NoOfEmployees` | number | Result of the operation | | `Result.AnnualRevenue` | number | Result of the operation | | `Result.ContactInfo` | object | Result of the operation | | `Result.ContactInfo.PreferredContactMethod` | string | HTTP method to use | | `Result.ContactInfo.PrimaryPhone` | string | Result of the operation | | `Result.ContactInfo.PrimaryFax` | string | Result of the operation | | `Result.ContactInfo.PrimaryEmail` | string | Result of the operation | | `Result.ContactInfo.Country` | string | Result of the operation | | `Result.ContactInfo.Street` | string | Result of the operation | | `Result.ContactInfo.City` | string | Result of the operation | | `Result.ContactInfo.State` | string | Result of the operation | | `Result.ContactInfo.ZipCode` | string | Result of the operation | | `Result.ContactInfo.PrimaryTextMessagePhone` | string | Result of the operation | ### Output Example `{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"TotalRecords":0,"Result":[{}],"ResponseCode":0,"Status":"string","Error":"string"}}` ## Get Scheduled Agent Procedures This action returns an array of agent procedure schedule records for a specified agent. ### Endpoint - **URL:** `/automation/agentprocs/{{agentId}}/scheduledprocs` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ------------------------- | -------- | ------------ | -------------------------------------------------------- | | `path_parameters.agentId` | number | Required | Parameters for the Get Scheduled Agent Procedures action | | `parameters.filter` | string | Optional | Parameters for the Get Scheduled Agent Procedures action | | `parameters.orderby` | string | Optional | Parameters for the Get Scheduled Agent Procedures action | ### Input Example `{"parameters":{"filter":"substringof('cab', OrgName)","orderby":"Priority"},"path_parameters":{"agentId":0}}` ### Output | **Parameter** | **Type** | **Description** | | ------------------------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `TotalRecords` | number | Output field: TotalRecords | | `Result` | array | Result of the operation | | `Result.AgentProcedureId` | number | Unique identifier | | `Result.AgentProcedureName` | string | Name of the resource | | `Result.NextExecTime` | string | Result of the operation | | `Result.Status` | string | Status value | | `Result.Admin` | string | Result of the operation | | `Result.Recurrence` | string | Result of the operation | | `Result.Attributes` | object | Result of the operation | | `Result.AgentId` | number | Unique identifier | | `Result.ServerTimeZone` | boolean | Result of the operation | | `Result.SkipIfOffLine` | boolean | Result of the operation | | `Result.PowerUpIfOffLine` | boolean | Result of the operation | | `Result.ScriptPrompts` | object | Result of the operation | | `Result.ScriptPrompts.Caption` | string | Result of the operation | | `Result.ScriptPrompts.Name` | string | Name of the resource | | `Result.ScriptPrompts.Value` | string | Value for the parameter | | `Result.Distribution` | object | Result of the operation | | `Result.Distribution.interval` | string | Result of the operation | | `Result.Distribution.magnitude` | number | Result of the operation | | `Result.Start` | object | Result of the operation | | `Result.Start.StartOn` | string | Result of the operation | | `Result.Start.StartAt` | string | Result of the operation | ### Output Example `{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"TotalRecords":10,"Result":[{}],"ResponseCode":0,"Status":"OK","Error":"None"}}` ## Run Agent Procedure This action runs an agent procedure immediately for a single agent. ### Endpoint - **URL:** `/automation/agentprocs/{{agentId}}/{{agentProcId}}/runnow` - **Method:** `PUT` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------------------- | -------- | ------------ | --------------------------------------------- | | `path_parameters.agentId` | number | Required | Parameters for the Run Agent Procedure action | | `path_parameters.agentProcId` | number | Required | Parameters for the Run Agent Procedure action | ### Input Example `{"path_parameters":{"agentId":0,"agentProcId":1}}` ### Output | **Parameter** | **Type** | **Description** | | -------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `Result` | boolean | Result of the operation | | `ResponseCode` | number | Output field: ResponseCode | | `Status` | string | Status value | | `Error` | string | Error message if any | ### Output Example `{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"Result":true,"ResponseCode":0,"Status":"string","Error":"string"}}` ## Schedule Agent Procedure This action schedules an agent procedure for a single agent. ### Endpoint - **URL:** `/automation/agentprocs/{{agentId}}/{{agentProcId}}/schedule` - **Method:** `PUT` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------------------- | -------- | ------------ | -------------------------------------------------- | | `path_parameters.agentId` | number | Required | Parameters for the Schedule Agent Procedure action | | `path_parameters.agentProcId` | number | Required | Parameters for the Schedule Agent Procedure action | ### Input Example `{"path_parameters":{"agentId":0,"agentProcId":1}}` ### Output | **Parameter** | **Type** | **Description** | | ---------------------------------- | -------- | ---------------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `agentId` | number | Unique identifier | | `agentProcId` | number | Unique identifier | | `ServerTimeZone` | boolean | Output field: ServerTimeZone | | `SkipIfOffLine` | boolean | Output field: SkipIfOffLine | | `PowerUpIfOffLine` | boolean | Output field: PowerUpIfOffLine | | `ScriptPrompts` | array | Output field: ScriptPrompts | | `ScriptPrompts.Caption` | string | Output field: ScriptPrompts.Caption | | `ScriptPrompts.Name` | string | Name of the resource | | `ScriptPrompts.Value` | string | Value for the parameter | | `Recurrence` | object | Output field: Recurrence | | `Recurrence.Repeat` | string | Output field: Recurrence.Repeat | | `Recurrence.Times` | number | Output field: Recurrence.Times | | `Recurrence.DaysOfWeek` | string | Output field: Recurrence.DaysOfWeek | | `Recurrence.DayOfMonth` | string | Output field: Recurrence.DayOfMonth | | `Recurrence.SpecificDayOfMonth` | number | Output field: Recurrence.SpecificDayOfMonth | | `Recurrence.MonthOfYear` | string | Output field: Recurrence.MonthOfYear | | `Recurrence.EndAt` | string | Output field: Recurrence.EndAt | | `Recurrence.EndOn` | string | Output field: Recurrence.EndOn | | `Recurrence.EndAfterIntervalTimes` | number | Output field: Recurrence.EndAfterIntervalTimes | | `Distribution` | object | Output field: Distribution | | `Distribution.Interval` | string | Output field: Distribution.Interval | | `Distribution.Magnitude` | number | Output field: Distribution.Magnitude | | `Start` | object | Output field: Start | ### Output Example `{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"agentId":0,"agentProcId":1,"ServerTimeZone":true,"SkipIfOffLine":true,"PowerUpIfOffLine":true,"ScriptPrompts":[{}],"Recurrence":{"Repeat":"Never","Times":0,"DaysOfWeek":"string","DayOfMonth":"FirstSunday","SpecificDayOfMonth":0,"MonthOfYear":"January","EndAt":"T0000","EndOn":"2016-02-05T21:02:56.650Z","EndAfterIntervalTimes":0},"Distribution":{"Interval":"Minutes","Magnitude":0},"Start":{"StartOn":"2016-02-05T21:02:56.650Z","St...` ## Update Organization This action updates a single organization record. ### Endpoint - **URL:** `/system/orgs/{{orgId}}` - **Method:** `PUT` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ------------------------------------- | -------- | ------------ | --------------------------------------------- | | `path_parameters.orgId` | number | Required | Parameters for the Update Organization action | | `OrgId` | number | Optional | Unique identifier | | `OrgName` | string | Optional | Name of the resource | | `OrgRef` | string | Optional | Parameter for Update Organization | | `OrgType` | string | Optional | Type of the resource | | `DefaultDepartmentName` | string | Optional | Name of the resource | | `DefaultMachineGroupName` | string | Optional | Name of the resource | | `ParentOrgId` | number | Optional | Unique identifier | | `Website` | string | Optional | Parameter for Update Organization | | `NoOfEmployees` | number | Optional | Parameter for Update Organization | | `AnnualRevenue` | number | Optional | Parameter for Update Organization | | `ContactInfo` | object | Optional | Parameter for Update Organization | | `ContactInfo.PreferredContactMethod` | string | Optional | HTTP method to use | | `ContactInfo.PrimaryPhone` | string | Optional | Parameter for Update Organization | | `ContactInfo.PrimaryFax` | string | Optional | Parameter for Update Organization | | `ContactInfo.PrimaryEmail` | string | Optional | Parameter for Update Organization | | `ContactInfo.Country` | string | Optional | Parameter for Update Organization | | `ContactInfo.Street` | string | Optional | Parameter for Update Organization | | `ContactInfo.City` | string | Optional | Parameter for Update Organization | | `ContactInfo.State` | string | Optional | Parameter for Update Organization | | `ContactInfo.ZipCode` | string | Optional | Parameter for Update Organization | | `ContactInfo.PrimaryTextMessagePhone` | string | Optional | Response message | | `CustomFields` | array | Optional | Parameter for Update Organization | | `CustomFields.FieldName` | string | Optional | Name of the resource | | `CustomFields.FieldValue` | string | Optional | Value for the parameter | ### Input Example `{"json_body":{"OrgId":0,"OrgName":"string","OrgRef":"string","OrgType":"string","DefaultDepartmentName":"string","DefaultMachineGroupName":"string","ParentOrgId":0,"Website":"string","NoOfEmployees":0,"AnnualRevenue":0,"ContactInfo":{"PreferredContactMethod":"string","PrimaryPhone":"string","PrimaryFax":"string","PrimaryEmail":"string","Country":"string","Street":"string","City":"string","State":"string","ZipCode":"string","PrimaryTextMessagePhone":"string"},"CustomFields":[{"FieldName":"string","FieldValue":"string"}],"Attributes":{}},"path_parameters":{"orgId":0}}` ### Output | **Parameter** | **Type** | **Description** | | -------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `ResponseCode` | number | Output field: ResponseCode | | `Status` | string | Status value | | `Error` | string | Error message if any | ### Output Example `{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"ResponseCode":200,"Status":"OK","Error":"None"}}` # Response Headers | **Header** | **Description** | **Example** | | ------------ | ----------------------------------------------------- | ----------------------------- | | Content-Type | The media type of the resource | application/json | | Date | The date and time at which the message was originated | Thu, 01 Jan 2024 00:00:00 GMT |