---
title: "Retrieve installed software."
method: GET
path: "/api/v1/accounts/{accountId}/softwareinventory"
---

# Retrieve installed software.

`GET /api/v1/accounts/{accountId}/softwareinventory`

## Request

- Base URL: `https://api.usa.cloud.watchguard.com/rest/aether-endpoint-security/aether-mgmt`
- URL: `https://api.usa.cloud.watchguard.com/rest/aether-endpoint-security/aether-mgmt/api/v1/accounts/{accountId}/softwareinventory`
- Auth: API key in header `WatchGuard-API-Key` and HTTP bearer
- TypeScript: <https://skmtc.dev/watchguard/apis/aether-endpoint-security-api/docs/api/v1/accounts/:accountId/softwareinventory/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves the software installed on the computers on the network.

## Path parameters

- `accountId` string, required

## Query parameters

- `top` integer
- `skip` integer
- `count` boolean
- `filter` string

## Response `200`

OK

- SoftwareInventoryOutputFindResponse
  - `data` SoftwareInventoryOutput
    - `site_id` string, uuid: Identifier of the site.
    - `site_name` string: Name of the site the device belongs to.
    - `device_id` string, uuid: Identifier of the device.
    - `host_name` string: Host name of the device.
    - `description` string: Name of device description.
    - `device_type` 1 | 2 | 3 | 4: Type of device. - 1: Workstation - 2: Laptop - 3: Server - 4: Mobile device
    - `platform_id` 1 | 2 | 3 | 4 | 5: Device platform. - 1: Windows - 2: Linux - 3: macOS - 4: Android - 5: iOS
    - `ip_address` string: IP address of the device.
    - `domain` string: Domain of device.
    - `operating_system` string: Name of the operating system installed on the device.
    - `custom_group_folder_id` string, uuid: Identifier of the custom group folder assigned.
    - `name` string: Name of the software installed on the device.
    - `publisher` string: Software vendor name.
    - `version` string: Version of the software installed on the device.
    - `size` integer, nullable: Size of the software installed on the device (if available).
    - `installation_date` string, date-time, nullable: Software installation date (if available).
    - `is_patch` boolean: Indicates whether the software is a patch.
  - `total_items` integer, nullable: Total number of retrieved software programs

## Other responses

- `400`: BAD REQUEST.
- `403`: ACCESS DENIED.
- `404`: NOT FOUND.
- `405`: METHOD NOT ALLOWED.
- `500`: INTERNAL ERROR.

---

[API](https://skmtc.dev/watchguard/apis/aether-endpoint-security-api.md) - [All operations](https://skmtc.dev/watchguard/apis/aether-endpoint-security-api/llms.txt) - [OpenAPI document](https://skmtc.dev/watchguard/apis/aether-endpoint-security-api/revisions/1376eee70d39?raw)