# Kaseya VSA

> Work with Kaseya VSA remote monitoring and management: find agents, assets, organizations and machine groups, read and close alarms, run or schedule agent procedures, check patches and audits, work Service Desk tickets, and start workflows on new alarms, offline or new agents, new or changed tickets and finished agent procedures.

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/kaseya-vsa

## Actions

### Add ticket note

Add a note to a ticket, shown to the submitter or hidden for technicians only.

**Inputs**

- Ticket ID (`ticket_id`, text, required): The ticket's id (ServiceDeskTicketId), from 'List tickets', a ticket trigger or an earlier step.
- Note (`text`, text, required): The note's text.
- Hidden (`hidden`, true/false): Keep the note for technicians only, hidden from the submitter.

**Outputs**

- `added` (true/false): Always true once added
- `hidden` (true/false): Whether the note is hidden from the submitter
- `note_id` (text): The new note's id, when VSA returns one
- `ticket_id` (text): The ticket

**Example output**

```json
{
  "added": true,
  "hidden": false,
  "note_id": "281365297027569",
  "ticket_id": "15293212440025500597997781"
}
```

### Close alarm

Close an alarm, as a technician does once it's dealt with, with a note saying why.

**Inputs**

- Alarm ID (`alarm_id`, text, required): The alarm's id, from 'List alarms', the new alarm trigger or an earlier step.
- Reason (`notes`, text): Why the alarm is closed, kept with it in VSA.

**Outputs**

- `alarm_id` (text): The alarm closed
- `closed` (true/false): Always true once closed
- `notes` (text): The reason given, empty if none

**Example output**

```json
{
  "alarm_id": "29170",
  "closed": true,
  "notes": "Disk cleaned up."
}
```

### Create ticket

Open a ticket in a service desk with a summary and description, optionally its priority, status, category and submitter.

**Inputs**

- Service desk (`service_desk_id`, text, required): The service desk. Pick one, or give its id.
- Summary (`summary`, text, required): The ticket's one-line summary.
- Description (`description`, text): The full description of the problem or request.
- Priority (`priority`, text): The ticket's priority. Leave empty for the desk's default.
- Status (`status`, text): The ticket's status. Leave empty for the desk's default.
- Category (`category`, text): The ticket's category.
- Submitter name (`submitter_name`, text): Who asked for help.
- Submitter email (`submitter_email`, text): Their email address, for VSA's replies.

**Outputs**

- `ticket` (object): The new ticket
- `ticket_id` (text): The new ticket's id

**Example output**

```json
{
  "ticket": {
    "AgentGuid": "568648809224995",
    "Assignee": "Tier1Support",
    "AssigneeEmail": "tier1@msp.example",
    "Category": "Hardware",
    "Closed": "",
    "CreatedDate": "2026-11-17T10:56:27",
    "Due": "2026-11-18T10:56:27",
    "IsArchived": false,
    "IsClosed": false,
    "LastPublicUpdate": "2026-11-17T11:02:17",
    "ModifiedDate": "2026-11-17T11:02:17",
    "Notes": [
      {
        "Hidden": false,
        "NoteId": "281365297027568",
        "SystemFlag": false,
        "Text": "Restarted the print spooler; watching it.",
        "Timestamp": "2026-11-17T11:02:17",
        "User": "kadmin"
      }
    ],
    "Organization": "Acme Corp",
    "Owner": "alice",
    "Priority": "Medium",
    "RelatedTickets": [
      {
        "Status": "Closed",
        "Summary": "Printer jams",
        "TicketRef": "STD000000"
      }
    ],
    "Resolution": "",
    "ResolutionNote": "",
    "ServiceDeskId": "68356648120026516947479448",
    "ServiceDeskTicketId": "15293212440025500597997781",
    "Severity": "",
    "SourceType": "ServiceDesk",
    "Staff": "",
    "Stage": "Identified",
    "Submitter": "alice",
    "SubmitterEmail": "alice@acme.example",
    "Summary": "Printer on the third floor is offline",
    "TicketRef": "STD000001",
    "TicketStatus": "Open",
    "TotalHours": 0.5
  },
  "ticket_id": "15293212440025500597997781"
}
```

### Get agent

Get one agent: its machine, operating system, network, who is signed in, whether it is online and when it last checked in.

**Inputs**

- Agent (`agent_id`, text, required): The agent (managed machine). Pick one, or give its id from an earlier step.

**Outputs**

- `agent` (object): The agent

**Example output**

```json
{
  "agent": {
    "AgentId": "568648809224995",
    "AgentName": "frontdesk-pc.root.acme",
    "AgentVersion": 9050012,
    "ComputerName": "FRONTDESK-PC",
    "ConnectionGatewayIP": "203.0.113.10",
    "Contact": "Jo Smith",
    "Country": "United States",
    "CpuCount": 8,
    "CpuSpeed": 2400,
    "CpuType": "Intel(R) Core(TM) i5-1135G7",
    "CurrentUser": "",
    "DefaultGateway": "192.168.1.1",
    "DomainWorkgroup": "ACME",
    "FirstCheckIn": "2025-03-02T14:20:05",
    "IPAddress": "192.168.1.24",
    "IPv6Address": "",
    "LastCheckInTime": "2026-11-17T09:41:52",
    "LastLoggedInUser": "jsmith",
    "LastRebootTime": "2026-11-15T07:02:11",
    "MachineGroup": "root.acme",
    "MachineGroupId": "38591172334412759034671215",
    "OSInfo": "Professional x64 Edition Build 19045",
    "OSType": "10",
    "OSVersion": "10.0.19045",
    "Online": 1,
    "OperatingSystem": "Windows",
    "OrgId": "71839104423118472934516631",
    "RamMBytes": 16384,
    "TimeZone": "Central Standard Time",
    "is_online": true,
    "status": "Online, nobody signed in"
  }
}
```

### Get alarm

Get one alarm: what raised it, its message, the agent it is about, whether it is open and any ticket made from it.

**Inputs**

- Alarm ID (`alarm_id`, text, required): The alarm's id, from 'List alarms', the new alarm trigger or an earlier step.

**Outputs**

- `alarm` (object): The alarm

**Example output**

```json
{
  "alarm": {
    "AdminName": "kadmin",
    "AgentId": "568648809224995",
    "AlarmEmail": "alerts@msp.example",
    "AlarmId": "29170",
    "AlarmSubject": "Monitoring alarm: Disk space low on C:",
    "AlarmType": "Counter",
    "AlertType": 4,
    "EventTime": "2026-11-17T09:30:12",
    "MachineGroup": "root.acme",
    "Message": "Free space on C: is 4% (under the 10% threshold).",
    "MonitorAlarmStateId": 1,
    "MonitorType": 0,
    "TicketId": "",
    "agentName": "frontdesk-pc.root.acme",
    "state": "Open"
  }
}
```

### Get asset

Get one asset's hardware details: BIOS, processors, memory, drives and network addresses.

**Inputs**

- Asset ID (`asset_id`, text, required): The asset's id (AssetId), from 'List assets' or an earlier step.

**Outputs**

- `asset` (object): The asset

**Example output**

```json
{
  "asset": {
    "AgentId": "568648809224995",
    "AssetId": "45218839210477163829574001",
    "AssetName": "frontdesk-pc",
    "AssetTypeId": "1",
    "DeviceFounds": [
      {
        "DeviceBiosInfo": {
          "BiosReleaseDate": "2024-06-11T00:00:00",
          "BiosVendor": "Dell Inc.",
          "BiosVersion": "1.18.0"
        },
        "DeviceDrives": [
          {
            "DriveManufacturer": "Samsung"
          }
        ],
        "DeviceIPs": [
          {
            "DHCPEnabled": true,
            "IPAddress": "192.168.1.24",
            "MACAddress": "00-1A-2B-3C-4D-5E",
            "SubnetMask": "255.255.255.0"
          }
        ],
        "DeviceId": "882100457",
        "DeviceInfo": {
          "HostName": "FRONTDESK-PC",
          "Manufacturer": "Dell Inc.",
          "OSFamily": "Windows",
          "OSName": "Windows 10",
          "OSType": "Windows",
          "SerialNumber": "5CG1234XYZ",
          "Version": "1.0"
        },
        "DeviceMemories": [
          {
            "MemorySize": 16384
          }
        ],
        "DeviceProcessors": [
          {
            "ProcessorFamily": "Core i5"
          }
        ],
        "FoundOn": "2025-03-02T14:20:05"
      }
    ],
    "DeviceId": "882100457",
    "DeviceName": "FRONTDESK-PC",
    "DeviceTime": "2026-11-17T09:41:52",
    "MachineGroup": "root.acme",
    "MachineGroupId": "38591172334412759034671215",
    "OrgId": "71839104423118472934516631",
    "ServerTime": "2026-11-17T15:41:52"
  }
}
```

### Get audit summary

Get an agent's latest audit: make, model and serial number, network, chassis, BIOS and check-in times.

**Inputs**

- Agent (`agent_id`, text, required): The agent (managed machine). Pick one, or give its id from an earlier step.

**Outputs**

- `agent_id` (text): The agent
- `audit` (object): The agent's latest audit

**Example output**

```json
{
  "agent_id": "568648809224995",
  "audit": {
    "BIOS": {
      "BiosReleaseDate": "2024-06-11T00:00:00",
      "BiosVendor": "Dell Inc.",
      "BiosVersion": "1.18.0"
    },
    "Chassis": {
      "ChassisManufacturer": "Dell Inc.",
      "ChassisSerialNumber": "5CG1234XYZ",
      "ChassisType": "Notebook"
    },
    "LastAudit": "2026-11-16T23:10:00",
    "NetworkInfo": {
      "DefaultGateway": "192.168.1.1",
      "DnsServer": "192.168.1.1",
      "IpAddress": "192.168.1.24",
      "MacAddr": "00-1A-2B-3C-4D-5E",
      "SubnetMask": "255.255.255.0"
    },
    "NextAudit": "2026-11-23T23:10:00",
    "SystemInfo": {
      "Manufacturer": "Dell Inc.",
      "ProductName": "Latitude 5420",
      "SysSerialNumber": "5CG1234XYZ",
      "Version": "1.0"
    },
    "TimeInfo": {
      "AgentTimeZone": "-360",
      "FirstCheckin": "2025-03-02T14:20:05",
      "LastCheckin": "2026-11-17T09:41:52",
      "LastReboot": "2026-11-15T07:02:11"
    }
  }
}
```

### Get current user

Get the VSA user the connection signs in as: name, email and when the account was created.

**Inputs**: None.

**Outputs**

- `user` (object): The signed-in user

**Example output**

```json
{
  "user": {
    "CreationDate": "2024-01-08T16:27:40",
    "Email": "kadmin@msp.example",
    "FirstName": "Kay",
    "LastName": "Admin",
    "UserId": "55957651"
  }
}
```

### Get patch status

Get an agent's patch status: when it was last scanned, when the next scan and update run, and its reboot settings.

**Inputs**

- Agent (`agent_id`, text, required): The agent (managed machine). Pick one, or give its id from an earlier step.

**Outputs**

- `agent_id` (text): The agent
- `patch_status` (object): The agent's patch status

**Example output**

```json
{
  "agent_id": "568648809224995",
  "patch_status": {
    "ExecScriptTime": "2026-11-16T22:00:00",
    "LastPatchScan": "2026-11-16T22:00:00",
    "NewPatchAlert": 1,
    "NextRunTime": "2026-11-20T02:00:00",
    "PatchFailedAlert": 1,
    "RebootDay": "Sunday",
    "RebootTime": "03:00",
    "ScanNextRunTime": "2026-11-23T22:00:00",
    "ScanResultsPending": "0"
  }
}
```

### Get ticket

Get one Service Desk ticket with its status, priority, assignee, submitter, dates and every note.

**Inputs**

- Ticket ID (`ticket_id`, text, required): The ticket's id (ServiceDeskTicketId), from 'List tickets', a ticket trigger or an earlier step.

**Outputs**

- `ticket` (object): The ticket, with its notes

**Example output**

```json
{
  "ticket": {
    "AgentGuid": "568648809224995",
    "Assignee": "Tier1Support",
    "AssigneeEmail": "tier1@msp.example",
    "Category": "Hardware",
    "Closed": "",
    "CreatedDate": "2026-11-17T10:56:27",
    "Due": "2026-11-18T10:56:27",
    "IsArchived": false,
    "IsClosed": false,
    "LastPublicUpdate": "2026-11-17T11:02:17",
    "ModifiedDate": "2026-11-17T11:02:17",
    "Notes": [
      {
        "Hidden": false,
        "NoteId": "281365297027568",
        "SystemFlag": false,
        "Text": "Restarted the print spooler; watching it.",
        "Timestamp": "2026-11-17T11:02:17",
        "User": "kadmin"
      }
    ],
    "Organization": "Acme Corp",
    "Owner": "alice",
    "Priority": "Medium",
    "RelatedTickets": [
      {
        "Status": "Closed",
        "Summary": "Printer jams",
        "TicketRef": "STD000000"
      }
    ],
    "Resolution": "",
    "ResolutionNote": "",
    "ServiceDeskId": "68356648120026516947479448",
    "ServiceDeskTicketId": "15293212440025500597997781",
    "Severity": "",
    "SourceType": "ServiceDesk",
    "Staff": "",
    "Stage": "Identified",
    "Submitter": "alice",
    "SubmitterEmail": "alice@acme.example",
    "Summary": "Printer on the third floor is offline",
    "TicketRef": "STD000001",
    "TicketStatus": "Open",
    "TotalHours": 0.5
  }
}
```

### List agent procedure history

List when each agent procedure last ran on an agent, how it went (Success or Failed) and who ran it, latest first.

**Inputs**

- Agent (`agent_id`, text, required): The agent (managed machine). Pick one, or give its id from an earlier step.
- Page size (`limit`, number): How many to return, 1 to 100. Defaults to 100, VSA's most. From 1 to 100.
- Offset (`offset`, number): How many to skip. Use 'next_offset' from an earlier page to read on. At least 0.

**Outputs**

- `agent_id` (text): The agent
- `count` (number): How many are on this page
- `has_more` (true/false): Whether another page follows
- `history` (list): Each procedure's latest run, latest first
- `next_offset` (number): The offset that reads the next page, 0 when none follows
- `total_records` (number): How many match in all, across every page

**Example output**

```json
{
  "agent_id": "568648809224995",
  "count": 1,
  "has_more": false,
  "history": [
    {
      "Admin": "kadmin",
      "LastExecutionTime": "2026-11-17T08:00:04",
      "ScriptName": "Config Windows Automatic Update",
      "Status": "Success THEN"
    }
  ],
  "next_offset": 0,
  "total_records": 1
}
```

### List agent procedures

List the agent procedures (VSA's scripts) the connected user can see, with their folders.

**Inputs**

- Name contains (`name_contains`, text): Only procedures whose name contains this text.
- Page size (`limit`, number): How many to return, 1 to 100. Defaults to 100, VSA's most. From 1 to 100.
- Offset (`offset`, number): How many to skip. Use 'next_offset' from an earlier page to read on. At least 0.

**Outputs**

- `count` (number): How many are on this page
- `has_more` (true/false): Whether another page follows
- `next_offset` (number): The offset that reads the next page, 0 when none follows
- `procedures` (list): The procedures, by name
- `total_records` (number): How many match in all, across every page

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "next_offset": 0,
  "procedures": [
    {
      "AgentProcedureId": "123",
      "AgentProcedureName": "Config Windows Automatic Update",
      "Description": "Turns on automatic updates.",
      "Path": "shared/sampleProc/windows"
    }
  ],
  "total_records": 1
}
```

### List agents

List agents (managed machines) by organization, machine group, status or name, with their operating system, IP address, current user and last check-in.

**Inputs**

- Organization (`org_id`, text): Only this organization. Leave empty for every organization.
- Machine group (`machine_group_id`, text): Only this machine group. Leave empty for every group.
- Status (`status`, text): Only agents that are online, offline, suspended or have never checked in. One of: `online`, `offline`, `suspended`, `never_checked_in` (Never checked in).
- Name contains (`name_contains`, text): Only agents whose name contains this text.
- Page size (`limit`, number): How many to return, 1 to 100. Defaults to 100, VSA's most. From 1 to 100.
- Offset (`offset`, number): How many to skip. Use 'next_offset' from an earlier page to read on. At least 0.

**Outputs**

- `agents` (list): The agents, by name
- `count` (number): How many are on this page
- `has_more` (true/false): Whether another page follows
- `next_offset` (number): The offset that reads the next page, 0 when none follows
- `total_records` (number): How many match in all, across every page

**Example output**

```json
{
  "agents": [
    {
      "AgentId": "568648809224995",
      "AgentName": "frontdesk-pc.root.acme",
      "AgentVersion": 9050012,
      "ComputerName": "FRONTDESK-PC",
      "ConnectionGatewayIP": "203.0.113.10",
      "Contact": "Jo Smith",
      "Country": "United States",
      "CpuCount": 8,
      "CpuSpeed": 2400,
      "CpuType": "Intel(R) Core(TM) i5-1135G7",
      "CurrentUser": "",
      "DefaultGateway": "192.168.1.1",
      "DomainWorkgroup": "ACME",
      "FirstCheckIn": "2025-03-02T14:20:05",
      "IPAddress": "192.168.1.24",
      "IPv6Address": "",
      "LastCheckInTime": "2026-11-17T09:41:52",
      "LastLoggedInUser": "jsmith",
      "LastRebootTime": "2026-11-15T07:02:11",
      "MachineGroup": "root.acme",
      "MachineGroupId": "38591172334412759034671215",
      "OSInfo": "Professional x64 Edition Build 19045",
      "OSType": "10",
      "OSVersion": "10.0.19045",
      "Online": 1,
      "OperatingSystem": "Windows",
      "OrgId": "71839104423118472934516631",
      "RamMBytes": 16384,
      "TimeZone": "Central Standard Time",
      "is_online": true,
      "status": "Online, nobody signed in"
    }
  ],
  "count": 1,
  "has_more": false,
  "next_offset": 0,
  "total_records": 1
}
```

### List alarms

List alarms, open and closed, newest first, for every agent or one, optionally between two times.

**Inputs**

- Agent (`agent_id`, text): Only this agent's alarms. Leave empty for every agent.
- Raised on or after (`since`, date and time): Only alarms raised at or after this time.
- Raised on or before (`until`, date and time): Only alarms raised at or before this time.
- Page size (`limit`, number): How many to return, 1 to 100. Defaults to 100, VSA's most. From 1 to 100.
- Offset (`offset`, number): How many to skip. Use 'next_offset' from an earlier page to read on. At least 0.

**Outputs**

- `alarms` (list): The alarms, newest first; state is Open or Closed
- `count` (number): How many are on this page
- `has_more` (true/false): Whether another page follows
- `next_offset` (number): The offset that reads the next page, 0 when none follows
- `total_records` (number): How many match in all, across every page

**Example output**

```json
{
  "alarms": [
    {
      "AgentId": "568648809224995",
      "AlarmId": "29170",
      "AlarmSubject": "Monitoring alarm: Disk space low on C:",
      "AlertType": 4,
      "EventTime": "2026-11-17T09:30:12",
      "MachineGroup": "root.acme",
      "MonitorAlarmStateId": 1,
      "agentName": "frontdesk-pc.root.acme",
      "state": "Open"
    }
  ],
  "count": 1,
  "has_more": false,
  "next_offset": 0,
  "total_records": 1
}
```

### List assets

List assets: machines with agents and devices VSA found on the network, with their alarm and ticket counts.

**Inputs**

- Organization (`org_id`, text): Only this organization. Leave empty for every organization.
- Machine group (`machine_group_id`, text): Only this machine group. Leave empty for every group.
- Name contains (`name_contains`, text): Only assets whose name contains this text.
- Page size (`limit`, number): How many to return, 1 to 100. Defaults to 100, VSA's most. From 1 to 100.
- Offset (`offset`, number): How many to skip. Use 'next_offset' from an earlier page to read on. At least 0.

**Outputs**

- `assets` (list): The assets, by name
- `count` (number): How many are on this page
- `has_more` (true/false): Whether another page follows
- `next_offset` (number): The offset that reads the next page, 0 when none follows
- `total_records` (number): How many match in all, across every page

**Example output**

```json
{
  "assets": [
    {
      "AgentId": "568648809224995",
      "AlarmCount": 2,
      "AssetId": "45218839210477163829574001",
      "AssetName": "frontdesk-pc",
      "AssetTypeId": "1",
      "DeviceManufacturer": "Dell Inc.",
      "DisplayName": "frontdesk-pc.root.acme",
      "HostName": "FRONTDESK-PC",
      "IsComputerAgent": true,
      "IsMobileAgent": false,
      "LastSeenDate": "2026-11-17T09:41:52",
      "MachineGroup": "root.acme",
      "MachineGroupId": "38591172334412759034671215",
      "OSFamily": "Windows",
      "OSName": "Windows 10",
      "OSType": "Windows",
      "OrgId": "71839104423118472934516631",
      "SysSerialNum": "5CG1234XYZ",
      "TicketCount": 1
    }
  ],
  "count": 1,
  "has_more": false,
  "next_offset": 0,
  "total_records": 1
}
```

### List machine groups

List machine groups, for every organization or for one.

**Inputs**

- Organization (`org_id`, text): Only this organization. Leave empty for every organization.
- Name contains (`name_contains`, text): Only machine groups whose name contains this text.
- Page size (`limit`, number): How many to return, 1 to 100. Defaults to 100, VSA's most. From 1 to 100.
- Offset (`offset`, number): How many to skip. Use 'next_offset' from an earlier page to read on. At least 0.

**Outputs**

- `count` (number): How many are on this page
- `has_more` (true/false): Whether another page follows
- `machine_groups` (list): The machine groups
- `next_offset` (number): The offset that reads the next page, 0 when none follows
- `total_records` (number): How many match in all, across every page

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "machine_groups": [
    {
      "MachineGroupId": "38591172334412759034671215",
      "MachineGroupName": "root",
      "OrgId": "71839104423118472934516631",
      "ParentMachineGroupId": ""
    }
  ],
  "next_offset": 0,
  "total_records": 1
}
```

### List missing patches

List the patches an agent's machine is missing, from its latest patch scan, with their KB articles.

**Inputs**

- Agent (`agent_id`, text, required): The agent (managed machine). Pick one, or give its id from an earlier step.
- Include denied patches (`include_denied`, true/false): Also list patches denied by patch policy.
- Page size (`limit`, number): How many to return, 1 to 100. Defaults to 100, VSA's most. From 1 to 100.
- Offset (`offset`, number): How many to skip. Use 'next_offset' from an earlier page to read on. At least 0.

**Outputs**

- `agent_id` (text): The agent
- `count` (number): How many are on this page
- `has_more` (true/false): Whether another page follows
- `next_offset` (number): The offset that reads the next page, 0 when none follows
- `patches` (list): The missing patches
- `total_records` (number): How many match in all, across every page

**Example output**

```json
{
  "agent_id": "568648809224995",
  "count": 1,
  "has_more": false,
  "next_offset": 0,
  "patches": [
    {
      "Description": "2026-11 Cumulative Update for Windows 10 Version 22H2",
      "Ignore": 0,
      "IsSuperseded": false,
      "KBArticle": "KB5046613",
      "PatchDataId": "51332",
      "PatchState": 0,
      "Product": "Windows 10",
      "ReleaseDate": "2026-11-11T00:00:00",
      "SecurityBulletinLink": "https://support.microsoft.com/help/5046613",
      "Status": 0,
      "UpdateClassification": 100
    }
  ],
  "total_records": 1
}
```

### List organizations

List the organizations (your customers, and your own) the connected user's scope can see.

**Inputs**

- Name contains (`name_contains`, text): Only organizations whose name contains this text.
- Page size (`limit`, number): How many to return, 1 to 100. Defaults to 100, VSA's most. From 1 to 100.
- Offset (`offset`, number): How many to skip. Use 'next_offset' from an earlier page to read on. At least 0.

**Outputs**

- `count` (number): How many are on this page
- `has_more` (true/false): Whether another page follows
- `next_offset` (number): The offset that reads the next page, 0 when none follows
- `organizations` (list): The organizations
- `total_records` (number): How many match in all, across every page

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "next_offset": 0,
  "organizations": [
    {
      "AnnualRevenue": 0,
      "ContactInfo": {
        "City": "Springfield",
        "Country": "United States",
        "PreferredContactMethod": "Email",
        "PrimaryEmail": "it@acme.example",
        "PrimaryFax": "",
        "PrimaryPhone": "+1 555 0100",
        "PrimaryTextMessagePhone": "",
        "State": "IL",
        "Street": "1 Main Street",
        "ZipCode": "62701"
      },
      "CustomFields": [
        {
          "FieldName": "Contract",
          "FieldValue": "Gold"
        }
      ],
      "DefaultDepartmentName": "root",
      "DefaultMachineGroupName": "root",
      "NoOfEmployees": 120,
      "OrgId": "71839104423118472934516631",
      "OrgName": "Acme Corp",
      "OrgRef": "acme",
      "OrgType": "Customer",
      "ParentOrgId": "",
      "Website": "https://acme.example"
    }
  ],
  "total_records": 1
}
```

### List service desks

List the Service Desk desks the connected user can see.

**Inputs**: None.

**Outputs**

- `count` (number): How many
- `service_desks` (list): The service desks

**Example output**

```json
{
  "count": 1,
  "service_desks": [
    {
      "DefaultPolicy": "",
      "Description": "Support requests from customers",
      "DeskAdministrator": "kadmin",
      "Prefix": "STD",
      "ServiceDeskId": "68356648120026516947479448",
      "ServiceDeskName": "Standard"
    }
  ]
}
```

### List tickets

List a service desk's tickets, newest first, by status, priority, summary or when they were opened or last changed.

**Inputs**

- Service desk (`service_desk_id`, text, required): The service desk. Pick one, or give its id.
- Status (`status`, text): Only tickets with this status. Leave empty for every status.
- Priority (`priority`, text): Only tickets with this priority. Leave empty for every priority.
- Summary contains (`summary_contains`, text): Only tickets whose summary contains this text.
- Opened on or after (`created_since`, date and time): Only tickets opened at or after this time.
- Changed on or after (`changed_since`, date and time): Only tickets changed at or after this time.
- Order (`order`, text): Newest first, oldest first, or most recently changed first. One of: `newest` (Newest first (default)), `oldest` (Oldest first), `recently_changed` (Most recently changed first). Default: `newest`.
- Page size (`limit`, number): How many to return, 1 to 100. Defaults to 100, VSA's most. From 1 to 100.
- Offset (`offset`, number): How many to skip. Use 'next_offset' from an earlier page to read on. At least 0.

**Outputs**

- `count` (number): How many are on this page
- `has_more` (true/false): Whether another page follows
- `next_offset` (number): The offset that reads the next page, 0 when none follows
- `tickets` (list): The tickets
- `total_records` (number): How many match in all, across every page

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "next_offset": 0,
  "tickets": [
    {
      "AgentGuid": "568648809224995",
      "Assignee": "Tier1Support",
      "Category": "Hardware",
      "Closed": "",
      "CreatedDate": "2026-11-17T10:56:27",
      "Due": "2026-11-18T10:56:27",
      "LastPublicUpdate": "2026-11-17T11:02:17",
      "ModifiedDate": "2026-11-17T11:02:17",
      "Organization": "Acme Corp",
      "Owner": "alice",
      "Priority": "Medium",
      "Resolution": "",
      "ServiceDeskId": "68356648120026516947479448",
      "ServiceDeskTicketId": "15293212440025500597997781",
      "Severity": "",
      "SourceType": "ServiceDesk",
      "Staff": "",
      "Stage": "Identified",
      "Submitter": "alice",
      "SubmitterEmail": "alice@acme.example",
      "Summary": "Printer on the third floor is offline",
      "TicketRef": "STD000001",
      "TicketStatus": "Open"
    }
  ],
  "total_records": 1
}
```

### List users

List VSA's users (the technicians who sign in to VSA), with their names, emails, roles and scopes.

**Inputs**

- Name contains (`name_contains`, text): Only users whose name contains this text.
- Page size (`limit`, number): How many to return, 1 to 100. Defaults to 100, VSA's most. From 1 to 100.
- Offset (`offset`, number): How many to skip. Use 'next_offset' from an earlier page to read on. At least 0.

**Outputs**

- `count` (number): How many are on this page
- `has_more` (true/false): Whether another page follows
- `next_offset` (number): The offset that reads the next page, 0 when none follows
- `total_records` (number): How many match in all, across every page
- `users` (list): The users, by user name

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "next_offset": 0,
  "total_records": 1,
  "users": [
    {
      "AdminName": "kadmin",
      "AdminRoleIds": [
        "2"
      ],
      "AdminScopeIds": [
        "2"
      ],
      "Admintype": 2,
      "CreationDate": "2024-01-08T16:27:40",
      "DefaultStaffDepartmentId": "",
      "DefaultStaffOrgId": "71839104423118472934516631",
      "DisableUntil": "",
      "Email": "kadmin@msp.example",
      "FirstName": "Kay",
      "LastName": "Admin",
      "UserId": "55957651"
    }
  ]
}
```

### Run agent procedure

Run an agent procedure on one agent's machine now. Use 'List agent procedure history' to see how it went.

**Inputs**

- Agent (`agent_id`, text, required): The agent (managed machine). Pick one, or give its id from an earlier step.
- Agent procedure (`procedure_id`, text, required): The agent procedure. Pick one, or give its id.

**Outputs**

- `agent_id` (text): The agent it runs on
- `procedure_id` (text): The procedure run
- `started` (true/false): Always true once VSA accepts it

**Example output**

```json
{
  "agent_id": "568648809224995",
  "procedure_id": "123",
  "started": true
}
```

### Run patch scan

Scan an agent's machine for missing patches now. 'List missing patches' shows what it found once it finishes.

**Inputs**

- Agent (`agent_id`, text, required): The agent (managed machine). Pick one, or give its id from an earlier step.

**Outputs**

- `agent_id` (text): The agent scanned
- `started` (true/false): Always true once VSA accepts it

**Example output**

```json
{
  "agent_id": "568648809224995",
  "started": true
}
```

### Schedule agent procedure

Schedule an agent procedure on one agent's machine, once or repeating, optionally skipping it or waking the machine if it is offline.

**Inputs**

- Agent (`agent_id`, text, required): The agent (managed machine). Pick one, or give its id from an earlier step.
- Agent procedure (`procedure_id`, text, required): The agent procedure. Pick one, or give its id.
- Start (`start_at`, date and time, required): When it first runs.
- Repeat (`repeat`, text): Run once, or again every few minutes, hours, days, weeks or months. One of: `Never` (Once (default)), `Minutes` (Every few minutes), `Hours` (Every few hours), `Days` (Every few days), `Weeks` (Every few weeks), `Months` (Every few months). Default: `Never`.
- Every (`every`, number): How many of those units between runs, such as 2 for every 2 days. Defaults to 1. From 1 to 1000.
- Skip if offline (`skip_if_offline`, true/false): Skip a run when the machine is offline at that time.
- Wake if offline (`power_up_if_offline`, true/false): Try to wake the machine (Wake on LAN) when it is offline at that time.

**Outputs**

- `agent_id` (text): The agent it runs on
- `every` (number): Units between runs, 0 if once
- `procedure_id` (text): The procedure scheduled
- `repeat` (text): Never, Minutes, Hours, Days, Weeks or Months
- `scheduled` (true/false): Always true once VSA accepts it
- `start_at` (text): When it first runs, in UTC

**Example output**

```json
{
  "agent_id": "568648809224995",
  "every": 1,
  "procedure_id": "123",
  "repeat": "Weeks",
  "scheduled": true,
  "start_at": "2026-11-18T02:00:00Z"
}
```

### Update ticket

Change a ticket's status or priority, or assign it to a staff member. What you leave empty stays as it is.

**Inputs**

- Service desk (`service_desk_id`, text, required): The service desk. Pick one, or give its id.
- Ticket ID (`ticket_id`, text, required): The ticket's id (ServiceDeskTicketId), from 'List tickets', a ticket trigger or an earlier step.
- Status (`status`, text): The ticket's new status.
- Priority (`priority`, text): The ticket's new priority.
- Assign to (`staff_id`, text): The staff member to assign it to.

**Outputs**

- `changed` (list): What changed: status, priority and assignee
- `ticket` (object): The ticket, as it is now

**Example output**

```json
{
  "changed": [
    "status"
  ],
  "ticket": {
    "AgentGuid": "568648809224995",
    "Assignee": "Tier1Support",
    "AssigneeEmail": "tier1@msp.example",
    "Category": "Hardware",
    "Closed": "",
    "CreatedDate": "2026-11-17T10:56:27",
    "Due": "2026-11-18T10:56:27",
    "IsArchived": false,
    "IsClosed": false,
    "LastPublicUpdate": "2026-11-17T11:02:17",
    "ModifiedDate": "2026-11-17T11:02:17",
    "Notes": [
      {
        "Hidden": false,
        "NoteId": "281365297027568",
        "SystemFlag": false,
        "Text": "Restarted the print spooler; watching it.",
        "Timestamp": "2026-11-17T11:02:17",
        "User": "kadmin"
      }
    ],
    "Organization": "Acme Corp",
    "Owner": "alice",
    "Priority": "Medium",
    "RelatedTickets": [
      {
        "Status": "Closed",
        "Summary": "Printer jams",
        "TicketRef": "STD000000"
      }
    ],
    "Resolution": "",
    "ResolutionNote": "",
    "ServiceDeskId": "68356648120026516947479448",
    "ServiceDeskTicketId": "15293212440025500597997781",
    "Severity": "",
    "SourceType": "ServiceDesk",
    "Staff": "",
    "Stage": "Identified",
    "Submitter": "alice",
    "SubmitterEmail": "alice@acme.example",
    "Summary": "Printer on the third floor is offline",
    "TicketRef": "STD000001",
    "TicketStatus": "Open",
    "TotalHours": 0.5
  }
}
```
