get-organization-inventory-devices
Retrieve a filtered list of devices from an organization's inventory, with support for pagination and filters by status, serial, model, network, and tags.
Instructions
Return the device inventory for an organization. (read-only)
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| organizationId | Yes | Organization ID | |
| perPage | No | The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. | |
| startingAfter | No | A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parame | |
| endingBefore | No | A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This paramete | |
| usedState | No | Filter results by used or unused inventory. Accepted values are 'used' or 'unused'. | |
| search | No | Search for devices in inventory based on serial number, mac address, or model. | |
| macs | No | Search for devices in inventory based on mac addresses. | |
| networkIds | No | Search for devices in inventory based on network ids. Use explicit 'null' value to get available devices only. | |
| serials | No | Search for devices in inventory based on serials. | |
| models | No | Search for devices in inventory based on model. | |
| orderNumbers | No | Search for devices in inventory based on order numbers. | |
| tags | No | Filter devices by tags. The filtering is case-sensitive. If tags are included, 'tagsFilterType' should also be included (see below). | |
| tagsFilterType | No | To use with 'tags' parameter, to filter devices which contain ANY or ALL given tags. Accepted values are 'withAnyTags' or 'withAllTags', def | |
| productTypes | No | Filter devices by product type. Accepted values are appliance, camera, campusGateway, cellularGateway, secureConnect, sensor, switch, system | |
| eoxStatuses | No | Filter devices by EoX status. Accepted values are 'endOfSale', 'endOfSupport', 'nearEndOfSupport', or 'null'. Use 'null' to filter for devic | |
| fields | No | Return only these top-level fields; omit for all. Available: claimedAt, countryCode, details, eox, licenseExpirationDate, mac, model, name, networkId, orderNumber, productType, serial, sku, tags. |