---
updatedAt: 2025-08-14T16:09:00.000Z
agentTools:
  siteIndex: https://developer.n-able.com/llms.txt
  projectIndex: https://developer.n-able.com/n-sight/llms.txt
---

# Listing Workstations

Service name: list_workstations

## Base URL

```
https://{SERVER}/api/?apikey={yourAPIkey}&service=list_workstations
```

## Description

Lists all workstation monitoring devices for a site (including top level asset information if available).

## Parameters

### Required parameters

Add required parameters immediately after the base URL.

```
https://{SERVER}/api/?apikey={yourAPIkey}&service=list_workstations&required_parameters={parameter-value}
```

| Parameter | Description                    | Type    | Options | Default |
| :-------- | :----------------------------- | :------ | :------ | :------ |
| siteid    | The siteid must be a valid id. | integer | 0       | 0       |

### Optional parameters

Add optional parameters after the required parameters in the base URL.

```
https://{SERVER}/api/?apikey={yourAPIkey}&service=list_workstations&required_parameters={parameter-value}&optional_parameters={parameter-value}
```

| Parameter                      | Description                                                                                                                                     | Type    | Options | Default |
| :----------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------- | :------ | :------ | :------ |
| [describe](describe-parameter) | Optional. Returns a description of the entered call, the available parameters, an example of its output, and returned fields with descriptions. | boolean | true    | 0       |

### Determine parameter values

Use the following associated service calls to determine parameter values.

| Parameter | Call                             | URL Format                                                                                    |
| :-------- | :------------------------------- | :-------------------------------------------------------------------------------------------- |
| siteid    | [list\_sites](listing-sites)     | https\://\{SERVER}/api/?apikey=\{yourAPIkey}\&service=list\_sites\&clientid=\{clientId value} |
| clientid  | [list\_clients](listing-clients) | https\://\{SERVER}/api/?apikey=\{yourAPIkey}\&service=list\_clients                           |

## Examples

### List workstations for a site

```
https://{SERVER}/api/?apikey={yourAPIkey}&service=list_workstations&siteid=SITEID
```

#### Example response

```xml
<result created="2009-09-24T16:41:12+01:00" host="SERVER" status="OK">
<items>
   <workstation>
    <guid></guid> 
    <name>PETE-LAPTOP</name> 
    <description>76508TG</description> 
    <install_date>2009-07-10</install_date> 
    <last_boot_time /> 
    <dsc_active>1</dsc_active> 
    <atz_dst_date>0000-03-05:00T01:00:00</atz_dst_date> 
    <utc_apt /> 
    <utc_offset>0</utc_offset> 
    <user>SERVER\peter </user> 
    <domain>test.local</domain> 
    <manufacturer>LENOVO</manufacturer> 
    <model>76508TG</model> 
    <ip>192.168.201.66</ip> 
    <external_ip>101.101.101.101</external_ip>
    <mac1>00:1C:BF:3D:03:AD</mac1> 
    <mac2>00:15:58:CC:D0:FE</mac2> 
    <mac3>18:E0:20:52:41:53</mac3> 
    <os>Microsoft Windows 7 Professional </os> 
    <os_details>Microsoft Windows 7 Professional Edition, 64-bit Service Pack 1 (build 7601) </os_details>
    <workstationid>38549</workstationid> 
    <agent_version>6_0_0</agent_version> 
    <agent_mode>3</agent_mode> 
    <online>1</online> 
    <active_247>0</active_247> 
    <check_interval_247>60</check_interval_247> 
    <status_247>5</status_247> 
    <local_date_247>2009-07-15</local_date_247> 
    <local_time_247>09:16:00</local_time_247> 
    <utc_time_247>2009-07-10 10:36:00</utc_time_247> 
    <dsc_hour>6</dsc_hour> 
    <dsc_status>1</dsc_status> 
    <dsc_local_date>2009-07-15</dsc_local_date> 
    <dsc_local_time>09:16:00</dsc_local_time> 
    <dsc_utc_time>2009-07-10 10:36:00</dsc_utc_time> 
    <tz_bias /> 
    <tz_dst_bias /> 
    <tz_std_bias /> 
    <tz_mode /> 
    <tz_dst_date>0000-03-05:00T01:00:00</tz_dst_date>
    <tz_std_date>0000-10-05:00T02:00:00</tz_std_date>
    <assetid>53614</assetid> 
    <wins_name>PETE-LAPTOP</wins_name> 
    <role>1</role> 
    <chassis_type>10</chassis_type> 
    <device_serial>L3G4568</device_serial> 
    <processor_count>1</processor_count> 
    <total_memory>3221225472</total_memory> 
    <os_type>18</os_type>
    <service_pack>3</service_pack> 
    <os_serial_number>12345-OEM-00123456-00123</os_serial_number> 
    <os_product_key>ABCD1-EFG2H-IJ2KLM-NO3PQ-RSTUV</os_product_key> 
    <last_scan_time>2009-07-10 10:36:00</last_scan_time> 
    <custom field name> custom value </custom fieldname>
   </workstation>
   ..... more <server> nodes ...
  </items>
</result>
   ..... more workstation nodes ...
</items>
</result>
```

## Returned fields

<Table align={["left","left","left","left"]}>
  <thead>
    <tr>
      <th>
        Field
      </th>

      <th>
        Type
      </th>

      <th>
        Can Be Empty
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        workstationid
      </td>

      <td>
        integer
      </td>

      <td>
        no
      </td>

      <td>
        Unique identifier of the monitored workstation.
      </td>
    </tr>

    <tr>
      <td>
        guid
      </td>

      <td>
        string
      </td>

      <td>
        yes
      </td>

      <td>
        The guid the monitored workstation uses to authenticate.
      </td>
    </tr>

    <tr>
      <td>
        name
      </td>

      <td>
        string
      </td>

      <td>
        no
      </td>

      <td>
        The name given to the monitored workstation.
      </td>
    </tr>

    <tr>
      <td>
        description
      </td>

      <td>
        string
      </td>

      <td>
        yes
      </td>

      <td>
        The description of the monitored workstation.
      </td>
    </tr>

    <tr>
      <td>
        agent\_version
      </td>

      <td>
        string
      </td>

      <td>
        yes
      </td>

      <td>
        The version of the Advanced Monitoring Agent installed on monitored workstation.
      </td>
    </tr>

    <tr>
      <td>
        install\_date
      </td>

      <td>
        date
      </td>

      <td>
        no
      </td>

      <td>
        The date the Advanced Monitoring Agent was installed on the monitored workstation.
      </td>
    </tr>

    <tr>
      <td>
        last\_boot\_time
      </td>

      <td>
        integer
      </td>

      <td>
        yes
      </td>

      <td>
        Timestamp of the last boot time of the monitored workstation.
      </td>
    </tr>

    <tr>
      <td>
        online
      </td>

      <td>
        integer (1 or 0)
      </td>

      <td>
        no
      </td>

      <td>
        Is workstation online or offline? <br/> 0: offline / maintenance mode <br/> 1: online
      </td>
    </tr>

    <tr>
      <td>
        active\_247
      </td>

      <td>
        integer (1 or 0)
      </td>

      <td>
        no
      </td>

      <td>
        Are 24x7 checks running on workstation? <br/> 0: No <br/> 1: Yes
      </td>
    </tr>

    <tr>
      <td>
        check\_interval\_247
      </td>

      <td>
        integer
      </td>

      <td>
        no
      </td>

      <td>
        Interval for 24x7 checks (minutes)
      </td>
    </tr>

    <tr>
      <td>
        status\_247
      </td>

      <td>
        integer
      </td>

      <td>
        no
      </td>

      <td>
        Status of 24x7 checks: <br/> 0: No checks run <br/> 1: Some checks failed <br/> 5: All checks passed
      </td>
    </tr>

    <tr>
      <td>
        local\_date\_247
      </td>

      <td>
        date
      </td>

      <td>
        no
      </td>

      <td>
        Date (on wkstn) of last 24x7 Checks upload.
      </td>
    </tr>

    <tr>
      <td>
        local\_time\_247
      </td>

      <td>
        time
      </td>

      <td>
        no
      </td>

      <td>
        Time (on wkstn) of last 24x7 Checks upload.
      </td>
    </tr>

    <tr>
      <td>
        utc\_time\_247
      </td>

      <td>
        datetime
      </td>

      <td>
        yes
      </td>

      <td>
        UTC date and time of last 24x7 Checks upload.
      </td>
    </tr>

    <tr>
      <td>
        dsc\_active
      </td>

      <td>
        integer
      </td>

      <td>
        no
      </td>

      <td>
        Are Daily Safety Checks running on workstation? <br/> 0: No <br/> 1: Yes
      </td>
    </tr>

    <tr>
      <td>
        agent\_mode
      </td>

      <td>
        integer
      </td>

      <td>
        no
      </td>

      <td>
        Agent mode: <br/> 1: Workstation
      </td>
    </tr>

    <tr>
      <td>
        dsc\_hour
      </td>

      <td>
        integer
      </td>

      <td>
        no
      </td>

      <td>
        Hour of day Daily Safety Checks are running.
      </td>
    </tr>

    <tr>
      <td>
        dsc\_status
      </td>

      <td>
        integer
      </td>

      <td>
        no
      </td>

      <td>
        Status of DSC checks: <br/> 0: No checks run <br/> 1: Some checks failed <br/> 5: All checks passed
      </td>
    </tr>

    <tr>
      <td>
        dsc\_local\_date
      </td>

      <td>
        date
      </td>

      <td>
        no
      </td>

      <td>
        Date (on wkstn) of last Daily Safety Checks upload.
      </td>
    </tr>

    <tr>
      <td>
        dsc\_local\_time
      </td>

      <td>
        time
      </td>

      <td>
        no
      </td>

      <td>
        Time (on wkstn) of last Daily Safety Checks upload.
      </td>
    </tr>

    <tr>
      <td>
        dsc\_utc\_time
      </td>

      <td>
        datetime
      </td>

      <td>
        yes
      </td>

      <td>
        UTC date and time of last Daily Safety Checks upload.
      </td>
    </tr>

    <tr>
      <td>
        tz\_bias
      </td>

      <td>
        integer
      </td>

      <td>
        yes
      </td>

      <td>
        The offset in minutes from UTC time
      </td>
    </tr>

    <tr>
      <td>
        tz\_dst\_bias
      </td>

      <td>
        integer
      </td>

      <td>
        yes
      </td>

      <td>
        The daylight saving time offset in minutes
      </td>
    </tr>

    <tr>
      <td>
        tz\_std\_bias
      </td>

      <td>
        integer
      </td>

      <td>
        yes
      </td>

      <td>
        The standard time offset in minutes
      </td>
    </tr>

    <tr>
      <td>
        tz\_mode
      </td>

      <td>
        integer
      </td>

      <td>
        yes
      </td>

      <td>
        The current time zone mode: <br/> 0: unknown <br/> 1: standard time <br/> 2: daylight saving time
      </td>
    </tr>

    <tr>
      <td>
        atz\_dst\_date
      </td>

      <td>
        string
      </td>

      <td>
        yes
      </td>

      <td>
        The date when daylight saving time begins
      </td>
    </tr>

    <tr>
      <td>
        tz\_dst\_date
      </td>

      <td>
        string
      </td>

      <td>
        yes
      </td>

      <td>
        The date when daylight saving time begins
      </td>
    </tr>

    <tr>
      <td>
        tz\_std\_date
      </td>

      <td>
        string
      </td>

      <td>
        yes
      </td>

      <td>
        The date when standard time begins
      </td>
    </tr>

    <tr>
      <td>
        utc\_apt
      </td>

      <td>
        datetime
      </td>

      <td>
        yes
      </td>

      <td>
        The Agent perceived UTC time
      </td>
    </tr>

    <tr>
      <td>
        utc\_offset
      </td>

      <td>
        integer
      </td>

      <td>
        yes
      </td>

      <td>
        The effective UTC offset in seconds
      </td>
    </tr>

    <tr>
      <td>
        assetid
      </td>

      <td>
        integer
      </td>

      <td>
        yes
      </td>

      <td>
        The workstation's unique physical asset identifier
      </td>
    </tr>

    <tr>
      <td>
        wins\_name
      </td>

      <td>
        string
      </td>

      <td>
        yes
      </td>

      <td>
        The WINS name of the physical asset.
      </td>
    </tr>

    <tr>
      <td>
        user
      </td>

      <td>
        string
      </td>

      <td>
        yes
      </td>

      <td>
        The user logged onto the physical asset during scan.
      </td>
    </tr>

    <tr>
      <td>
        domain
      </td>

      <td>
        string
      </td>

      <td>
        yes
      </td>

      <td>
        The domain the physical asset is a member of.
      </td>
    </tr>

    <tr>
      <td>
        role
      </td>

      <td>
        string
      </td>

      <td>
        yes
      </td>

      <td>
        The role being performed by physical asset: <br/> 0, 1: Windows Workstation <br/> 2, 3, 4, 5: Windows Server <br/> 101: UNIX/Linux <br/> 102: Mac <br/> 103: Printer <br/> 104: Router <br/> 105: NAS <br/> 106: Other Network Device <br/> other: Unknown
      </td>
    </tr>

    <tr>
      <td>
        chassis\_type
      </td>

      <td>
        integer
      </td>

      <td>
        yes
      </td>

      <td>
        Chassis type (physical workstations only): <br/> 8: Portable <br/> 9: Laptop <br/> 10: Notebook <br/> 11: Handheld <br/> 14: Subnotebook <br/> other: Unknown
      </td>
    </tr>

    <tr>
      <td>
        manufacturer
      </td>

      <td>
        string
      </td>

      <td>
        yes
      </td>

      <td>
        The manufacturer of the physical asset.
      </td>
    </tr>

    <tr>
      <td>
        model
      </td>

      <td>
        string
      </td>

      <td>
        yes
      </td>

      <td>
        The model of the physical asset.
      </td>
    </tr>

    <tr>
      <td>
        device\_serial
      </td>

      <td>
        string
      </td>

      <td>
        yes
      </td>

      <td>
        The serial number of the physical asset.
      </td>
    </tr>

    <tr>
      <td>
        ip
      </td>

      <td>
        string
      </td>

      <td>
        yes
      </td>

      <td>
        The IP address of the physical asset.
      </td>
    </tr>

    <tr>
      <td>
        external\_ip
      </td>

      <td>
        string
      </td>

      <td>
        yes
      </td>

      <td>
        The external IP address of the last agent upload.
      </td>
    </tr>

    <tr>
      <td>
        mac1
      </td>

      <td>
        string
      </td>

      <td>
        yes
      </td>

      <td>
        The MAC address of the first NIC in the physical asset.
      </td>
    </tr>

    <tr>
      <td>
        mac2
      </td>

      <td>
        string
      </td>

      <td>
        yes
      </td>

      <td>
        The MAC address of the second NIC in the physical asset.
      </td>
    </tr>

    <tr>
      <td>
        mac3
      </td>

      <td>
        string
      </td>

      <td>
        yes
      </td>

      <td>
        The MAC address of the third NIC in the physical asset.
      </td>
    </tr>

    <tr>
      <td>
        processor\_count
      </td>

      <td>
        integer
      </td>

      <td>
        yes
      </td>

      <td>
        The number of processors in the physical asset.
      </td>
    </tr>

    <tr>
      <td>
        total\_memory
      </td>

      <td>
        integer
      </td>

      <td>
        yes
      </td>

      <td>
        The total memory (bytes) in the physical asset.
      </td>
    </tr>

    <tr>
      <td>
        os\_type
      </td>

      <td>
        integer
      </td>

      <td>
        no
      </td>

      <td>
        Type of Operating System installed.
      </td>
    </tr>

    <tr>
      <td>
        os
      </td>

      <td>
        string
      </td>

      <td>
        yes
      </td>

      <td>
        The operating system installed on the physical asset. Returns device.osversion if no as\_device record.
      </td>
    </tr>

    <tr>
      <td>
        os\_details
      </td>

      <td>
        string
      </td>

      <td>
        yes
      </td>

      <td>
        A more detailed description of the operating system installed on the physical asset, including the build (if known).
      </td>
    </tr>

    <tr>
      <td>
        service\_pack
      </td>

      <td>
        float
      </td>

      <td>
        yes
      </td>

      <td>
        The service pack installed on the physical asset.
      </td>
    </tr>

    <tr>
      <td>
        os\_serial\_number
      </td>

      <td>
        string
      </td>

      <td>
        yes
      </td>

      <td>
        The operating system serial number.
      </td>
    </tr>

    <tr>
      <td>
        os\_product\_key
      </td>

      <td>
        string
      </td>

      <td>
        yes
      </td>

      <td>
        The operating system product key.
      </td>
    </tr>

    <tr>
      <td>
        last\_scan\_time
      </td>

      <td>
        datetime
      </td>

      <td>
        yes
      </td>

      <td>
        The date and time of last asset scan.
      </td>
    </tr>

    <tr>
      <td>
        custom field name
      </td>

      <td>
        string
      </td>

      <td>
        yes
      </td>

      <td>
        The information entered in the Custom Field.
      </td>
    </tr>
  </tbody>
</Table>