Software Inventory¶

Team Settings

The application list is collected only when the Allow receiving a list of software from devices option is enabled in the team settings. Learn more in the dedicated guide: Team Settings

Installed App List¶

You can get a list of installed applications on devices from Permanent Access using the inventory/program/list method.

Request:

HTTPcURL

GET /v1/inventory/program/list
  ?agent_id=<number>
  &group_id=<number>
  &type=<string>
  &date_from=<number>
  &date_to=<number>
  &version_from=<string>
  &version_to=<string>
  &name=<string>
  &publisher=<string>
  &search=<string>
  &offset=<number>
  &limit=<number>
Host: https://api.getscreen.me
X-Api-Key: YOUR_API_KEY

curl -G "https://api.getscreen.me/v1/inventory/program/list" \
  --data-urlencode "agent_id=<number>" \
  --data-urlencode "group_id=<number>" \
  --data-urlencode "type=<string>" \
  --data-urlencode "date_from=<number>" \
  --data-urlencode "date_to=<number>" \
  --data-urlencode "version_from=<string>" \
  --data-urlencode "version_to=<string>" \
  --data-urlencode "name=<string>" \
  --data-urlencode "publisher=<string>" \
  --data-urlencode "search=<string>" \
  --data-urlencode "offset=<number>" \
  --data-urlencode "limit=<number>" \
  -H "X-Api-Key: YOUR_API_KEY" \

Parameter	Type	Value
`agent_id`	`number`	Filter by device. Internal system device ID.
`group_id`	`number`	Filter by group. Internal system group ID.
`type`	`string`	Filter by installed application type. Possible values: `msi` - Application installed via Windows Installer (.msi) `registry` - Application detected only through a Windows Registry entry `dpkg` - Package installed via Debian package system (.deb) `rpm` - Package installed via RPM package manager (.rpm)
`date_from`	`number`	Filter by application installation date. Start of the period. Value in `unixtime` format.
`date_to`	`number`	Filter by application installation date. End of the period. Value in `unixtime` format.
`version_from`	`string`	Filter by application version. Minimum version. Value in Semantic Versioning (SemVer) format.
`version_to`	`string`	Filter by application version. Maximum version. Value in Semantic Versioning (SemVer) format.
`name`	`string`	Filter by application name. Exact match is used.
`publisher`	`string`	Filter by application publisher. Exact match is used.
`search`	`string`	Filter by application name and publisher. Case-insensitive substring match is used.
`offset`	`number`	Offset for the first item in the list
`limit`	`number`	Number of items in the list. Default value: `20`; maximum value: `100`

Response:

Example Response

Response Data

{
    "filter": {
        "type": "msi"
    },
    "data":[ {
        "agent_ids": [1001, 1002],
        "name": "WireGuard",
        "publisher": "WireGuard LLC",
        "version": "0.5.3"
    },{
        "agent_ids": [1003],
        "name": "Node.js",
        "publisher": "Node.js Foundation",
        "version": "8.11.4"
    }, ... ],
    "total": 1024,
    "offset": 0,
    "limit": 20,
}

Name	Type	Description
`data`	`object`	List of installed applications
`data.[].name`	`string`	Application name
`data.[].publisher`	`string`	Application publisher
`data.[].version`	`string`	Minimum application version used on the found devices
`data.[].agent_ids`	`array`	List of internal system device identifiers where the application is installed
`filter`	`object`	Filter applied to the list. Duplicated from the request.
`filter.group_id`	`number`	Internal system group ID
`filter.type`	`string`	Installed application type
`filter.date_from`	`number`	Start of the application installation date range
`filter.date_to`	`number`	End of the application installation date range
`filter.version_from`	`string`	Minimum application version
`filter.version_to`	`string`	Maximum application version
`filter.name`	`string`	Application name
`filter.publisher`	`string`	Application publisher
`filter.search`	`string`	Search by application name and publisher
`total`	`number`	Total number of records in the database.
`offset`	`number`	Zero-based index of the first record in the returned list.
`limit`	`number`	Maximum number of records returned in the list.