Get list of inventory items

GET

/v1/organizations/:organizationId/inventory-items/

Get list of inventory items

Required Permission: inventory.item.management.list

Get list of inventory items

Request

Add parameter in 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

devicesmartphonetabletlaptopdesktopComputerserversmartwatchhdmiAdapterdockStationmousekeyboardprinterscannermonitorexternalHardDriveusbFlashDrivewebcamheadphonesspeakermicrophoneposTerminalbarcodeScannercardReadersoftwareLicensevideoConferenceexternalDeviceswitchupscameraCctvcameraIpfirewallrouteraccessPointaccessControlvirtualMachine

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

type string optional

user employee mdmUser

memberId string optional

Match pattern: ^[a-fA-F0-9]{24}$

userId string optional

Match pattern: ^[a-fA-F0-9]{24}$

employeeId string optional

Match pattern: ^[a-fA-F0-9]{24}$

mdmUserId string optional

Match pattern: ^[a-fA-F0-9]{24}$

email string optional

≤ 256 characters · Format: email

fromMdmDevice boolean optional

basic object optional

status string optional

active inactive provisioning deleted delete_requested retired lost stolen destroyed sold inStock toBeReturned expired inRepair assigned external available damaged emergency unknown disabled returnedToProvider laptopNotRequired personalLaptop clientLaptop

type string required

device smartphone tablet laptop desktopComputer server smartwatch hdmiAdapter dockStation mouse keyboard printer scanner monitor externalHardDrive usbFlashDrive webcam headphones speaker microphone posTerminal barcodeScanner cardReader softwareLicense videoConference externalDevice switch ups cameraCctv cameraIp firewall router accessPoint accessControl virtualMachine

name string optional

≤ 128 characters

description string optional

≤ 256 characters

location string optional

≤ 128 characters

owner string optional

≤ 256 characters

classification string optional

high medium low

hardware object optional

manufacturer string optional

≤ 128 characters

model string optional

≤ 128 characters

osName string optional

macOS windows linux chromeOS android iOS iPadOS tvOS AOSP watchOS other Android Windows

osVersion string optional

≤ 128 characters

network object optional

hostname string optional

≤ 128 characters

ipAddress string optional

≤ 128 characters

macAddress string optional

≤ 128 characters

purchase object optional

provider string optional

≤ 128 characters

order string optional

≤ 128 characters

orderDate string optional

Format: date-time

pricing integer optional

≥ 0

frequency string optional

once monthly annual

partNumber string optional

≤ 128 characters

currency string optional

≤ 128 characters

identifiers object optional

inventoryId string optional

≤ 128 characters

serialNumber string optional

≤ 128 characters

imei string optional

≤ 128 characters

udid string optional

≤ 128 characters

foreignId string optional

≤ 256 characters

seats object optional

total integer optional

≥ 0

available integer optional

≥ 0

lifecycle object optional

warrantyExpirationDate string optional

Format: date-time

expectedUsefulLife integer optional

≥ 0

deviceInfo object optional

deviceType string optional

≤ 128 characters

mdmDeviceId string optional

Match pattern: ^[a-fA-F0-9]{24}$

deviceState string optional

active deleted delete_requested provisioning unknown

metadata object optional

notes array [object] optional

id string optional

Match pattern: ^[a-fA-F0-9]{24}$

note string optional

≤ 256 characters

user object optional

id string optional

Match pattern: ^[a-fA-F0-9]{24}$

email string optional

≤ 256 characters · Format: email

firstName string optional

≤ 128 characters

lastname string optional

≤ 128 characters

picture string optional

≤ 128 characters

createdAt string optional

Format: date-time

mdmDevice object optional

id string optional

Match pattern: ^[a-fA-F0-9]{24}$

summary object optional

type string optional

emmDevice admDevice winDevice

state string optional

ACTIVE DELETED DELETE_REQUESTED PROCESSING UNKNOWN

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"
    }
}