Get list of inventory items as csv

GET

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

Get list of inventory items as csv

Required Permission: inventory.item.management.list

Get list of inventory items as csv

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

{
  "type": "object",
  "properties": {}
}

400 Response application/json

status boolean optional

false

error object optional

code number optional

5138

message string optional

Not implemented

{
    "status": false,
    "error": {
        "code": 5138,
        "message": "Not implemented"
    }
}

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