Favicon

You are here: Home > API Reference > Platform > Inventoryitem > Get list of inventory items

Get list of inventory items

Required Permission: inventory.item.management.list

Get list of inventory items

GET
https://api.applivery.io/v1/organizations/{organizationId}/inventory-items 
curl -X GET "https://api.applivery.io/v1/organizations/{organizationId}/inventory-items" \
  -H "Authorization: Bearer <YOUR_API_KEY>"
const response = await fetch("https://api.applivery.io/v1/organizations/{organizationId}/inventory-items", {
  method: "GET",
  headers: {
    Authorization: "Bearer <YOUR_API_KEY>",
  },
});

const data = await response.json();
import requests

response = requests.get(
    "https://api.applivery.io/v1/organizations/{organizationId}/inventory-items",
    headers={"Authorization": "Bearer <YOUR_API_KEY>"},
)

data = response.json()

Request

Send your API key in the request header authorization
Example: Authorization: Bearer <token>

organizationId string
required
Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$

page integer
optional
Sequential page index for navigating large datasets, enabling systematic access to specific record subsets within the total collection.
limit integer
optional
Maximum number of records returned per request to control data density, optimize interface performance, and manage payload size
sort string
optional
Ordering criteria using a field-to-direction mapping to organize results based on specific attributes like creation date, name, or status.
Match pattern: ^[\w.]*((:asc)|(:desc))?$
search string
optional
≤ 256 characters
hasEnrolledDevice boolean
optional
showAll boolean
optional
basic.status string
optional
activeinactiveprovisioningdeleteddelete_requestedretiredloststolendestroyedsoldinStocktoBeReturnedexpiredinRepairassignedexternalavailabledamagedemergencyunknowndisabledreturnedToProviderlaptopNotRequiredpersonalLaptopclientLaptop
basic.name string
optional
≤ 128 characters
basic.type string
optional
devicesmartphonetabletlaptopdesktopComputerserversmartwatchhdmiAdapterdockStationmousekeyboardprinterscannermonitorexternalHardDriveusbFlashDrivewebcamheadphonesspeakermicrophoneposTerminalbarcodeScannercardReadersoftwareLicensevideoConferenceexternalDeviceswitchupscameraCctvcameraIpfirewallrouteraccessPointaccessControlvirtualMachinesimCardeSim
basic.description string
optional
≤ 128 characters
basic.location string
optional
≤ 128 characters
basic.owner string
optional
≤ 128 characters
basic.classification string
optional
highmediumlow
hardware.manufacturer string
optional
≤ 128 characters
hardware.model string
optional
≤ 128 characters
hardware.osName string
optional
≤ 128 characters
hardware.osVersion string
optional
≤ 128 characters
network.hostname string
optional
≤ 128 characters
network.ipAddress string
optional
≤ 128 characters
network.macAddress string
optional
≤ 128 characters
purchase.provider string
optional
≤ 128 characters
purchase.order string
optional
≤ 128 characters
purchase.orderDate string
optional
≤ 128 characters
purchase.pricing number
optional
Format: float
purchase.frequency string
optional
≤ 128 characters
purchase.partNumber string
optional
≤ 128 characters
purchase.currency string
optional
≤ 128 characters
identifiers.serialNumber string
optional
≤ 128 characters
identifiers.imei string
optional
≤ 128 characters
identifiers.udid string
optional
≤ 128 characters
identifiers.foreignId string
optional
≤ 128 characters
seats.available number
optional
Format: float
seats.total number
optional
Format: float
lifecycle.warrantyExpirationDate string
optional
Format: date-time
lifecycle.expectedUsefulLife number
optional
Format: float
deviceInfo.mdmDeviceId string
optional
Match pattern: ^[a-fA-F0-9]{24}$
deviceInfo.deviceState string
optional
activedeleteddelete_requestedprovisioningunknown
members.email string
optional
≤ 128 characters

Responses

200 Response application/json
status boolean optional
data object optional
items array [object] optional
id string optional
InventoryItemId
Match pattern: ^[a-fA-F0-9]{24}$
organizationId string optional
OrganizationId
Match pattern: ^[a-fA-F0-9]{24}$
members array [object] optional
basic object optional
hardware object optional
network object optional
purchase object optional
identifiers object optional
seats object optional
lifecycle object optional
deviceInfo object optional
metadata object optional
notes array [object] optional
mdmDevice object optional
inferredFields array [string] optional
createdBy string optional
Match pattern: ^[a-fA-F0-9]{24}$
updatedAt string optional
Format: date-time
createdAt string optional
Format: date-time
totalDocs integer optional
limit integer optional
hasPrevPage boolean optional
hasNextPage boolean optional
page integer optional
totalPages integer optional
prevPage integer optional
nextPage integer optional
lean boolean optional 
{
    "status": true,
    "data": {
        "items": [
            {
                "id": "string",
                "organizationId": "string",
                "members": [
                    {
                        "type": "user",
                        "memberId": "string",
                        "userId": "string",
                        "employeeId": "string",
                        "mdmUserId": "string",
                        "email": "[email protected]",
                        "fromMdmDevice": true
                    }
                ],
                "basic": {
                    "status": "active",
                    "type": "device",
                    "name": "string",
                    "description": "string",
                    "location": "string",
                    "owner": "string",
                    "classification": "high"
                },
                "hardware": {
                    "manufacturer": "string",
                    "model": "string",
                    "osName": "macOS",
                    "osVersion": "string"
                },
                "network": {
                    "hostname": "string",
                    "ipAddress": "string",
                    "macAddress": "string"
                },
                "purchase": {
                    "provider": "string",
                    "order": "string",
                    "orderDate": "2024-01-01T00: 00:00Z",
                    "pricing": 0,
                    "frequency": "once",
                    "partNumber": "string",
                    "currency": "string"
                },
                "identifiers": {
                    "inventoryId": "string",
                    "serialNumber": "string",
                    "imei": "string",
                    "udid": "string",
                    "foreignId": "string"
                },
                "seats": {
                    "total": 0,
                    "available": 0
                },
                "lifecycle": {
                    "warrantyExpirationDate": "2024-01-01T00: 00:00Z",
                    "expectedUsefulLife": 0
                },
                "deviceInfo": {
                    "deviceType": "string",
                    "mdmDeviceId": "string",
                    "deviceState": "active"
                },
                "metadata": {},
                "notes": [
                    {
                        "id": "string",
                        "note": "string",
                        "user": {
                            "id": "string",
                            "email": "[email protected]",
                            "firstName": "string",
                            "lastname": "string",
                            "picture": "string"
                        },
                        "createdAt": "2024-01-01T00: 00:00Z"
                    }
                ],
                "mdmDevice": {
                    "id": "string",
                    "summary": {},
                    "type": "emmDevice",
                    "state": "ACTIVE"
                },
                "inferredFields": [
                    "string"
                ],
                "createdBy": "string",
                "updatedAt": "2024-01-01T00: 00:00Z",
                "createdAt": "2024-01-01T00: 00:00Z"
            }
        ],
        "totalDocs": 0,
        "limit": 0,
        "hasPrevPage": true,
        "hasNextPage": true,
        "page": 0,
        "totalPages": 0,
        "prevPage": 0,
        "nextPage": 0,
        "lean": true
    }
}
401 Response application/json
status boolean optional
false
error object optional
code number optional
4004
message string optional
Invalid Token
{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}
404 Response application/json
status boolean optional
false
error object optional
code number optional
3001
message string optional
Entity not found
{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}