---
title: "Get user inventories"
method: GET
path: "/inventories/list"
tags: ["Inventory"]
---

# Get user inventories

`GET /inventories/list`

## Request

- Base URL: `https://asm.cloud.tenable.com/api/1.0`
- URL: `https://asm.cloud.tenable.com/api/1.0/inventories/list`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/tenable/apis/attack-surface-management/docs/inventories/list/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `offset` integer
- `limit` integer
- `search` string
- `sortby` string
- `sortorder` boolean
- `include_suggestion_count` boolean

## Response `200`

OK

- object
  - `list` object[], required: All user inventories with data in a json object
    - `inventory_id` integer, required: The inventory ID.
    - `current_asset_count` integer, required: Asset numbers to inventories.
    - `inventory_name` string, required: The inventory name
    - `source_suggestions` number, required: 1 if the inventory has source suggestions enabled
    - `business_id` number, required
    - `api_key` string, required: Api key
    - `enumeration_wordlist` string, required: Enumeration wordlist id from the predefined.json file
    - `has_custom_wordlist` boolean, required: True if the inventory has an uploaded custom wordlist
    - `users_total` number
    - `app_refresh_rate_days` integer: Number of days over which to spread the refresh cycle for assets. Inherited from the business.
    - `is_default` boolean, required: True if this inventory is set as the user's default inventory
  - `total` integer, required: Count of user inventories
  - `actualInventory` object, required: Current inventory data in a json object
    - `inventory_id` integer, required: The inventory ID.
    - `inventory_name` string, required: The inventory name
    - `current_asset_count` integer, required: Asset numbers to inventories.
    - `source_suggestions` number, required: 1 if the inventory has source suggestions enabled
    - `api_key` string, required: Api key
    - `ext_container_id` string
    - `notes` string
    - `users_total` integer, required
    - `suggestions_count` integer, required
    - `html_custom_column_enabled` boolean, required
    - `description` string, required
    - `business_id` number, required
    - `is_default` boolean, required: True if this inventory is set as the user's default inventory
  - `unseen_suggestions` integer: Number of unseen suggestions
  - `default_inventory_id` integer: ID of the user's default inventory

## Other responses

- `401`: Unauthorized
- `500`: Internal server error

---

[API](https://skmtc.dev/tenable/apis/attack-surface-management.md) - [All operations](https://skmtc.dev/tenable/apis/attack-surface-management/llms.txt) - [OpenAPI document](https://skmtc.dev/tenable/apis/attack-surface-management/revisions/465c06285e48?raw)