Documentation

Public API > Inventory API.

Documentation Menu

Inventory API

This page explains how to get your inventory data extracted. Note that the example array of computers further down shows only the first computer and a subset of software installed for readability. You can use query parameters to filter your search.

Resources

Headers

Filters

Filters can be supplied either as URL parameters or headers.
  • Example filtered url to get 10 entries: https://dc1api.adminbyrequest.com/inventory?wantsoftware=1&take=10
  • Pagination works by using the last id in the list and feeding it as startid in the next query

Fields

Example of Successful Request

				
					[
  {
    "id": 49779198,
    "name": "W10405945",
    "inventoryAvailable": true,
    "inventoryDate": "2020-03-27T08:17:11",
    "abrClientVersion": "6.3.0",
    "abrClientInstallDate": "2020-03-27T08:15:32",
    "notes": null,
    "user": {
      "account": "PDH",
      "fullName": "Paul David Hewson",
      "email": "pdh@acme.com",
      "phone": "555.345.6789",
      "domain": "ACME",
      "orgUnit": "Users",
      "orgUnitPath": "\\Users",
      "isAdmin": false,
      "isDomainJoined": true,
      "isAzureJoined": false,
      "groups": [
        "Domain Users",
        "Users"
      ]
    },
    "owner": {
        "account": "support@fasttracksoftware.com",
        "fullName": "FastTrack Software Support"
    },
    "computer": {
      "domain": "ACME",
      "isDomainJoined": true,
      "isAzureJoined": false,
      "orgUnit": "Computers",
      "orgUnitPath": "\\Computers",
      "groups": [
        "Domain Computers"
      ],
      "localAdmins": [
        "Administrator",
        "ACME\\Domain Admins"
      ],
      "users": []
    },
    "operatingSystem": {
      "platform": "Windows",
      "platformCode": 0,
      "name": "Windows 11 Pro Insider Preview",
      "version": "22H2",
      "release": 2009,
      "build": 25231,
      "buildUpdate": 1000,
      "type": "Workstation",
      "typeCode": 0,
      "bits": 64,
      "installDate": "2022-10-30T00:00:00"
    },
    "hardware": {
      "make": "Dell Inc.",
      "model": "XPS 9550",
      "type": "Laptop",
      "typeCode": 0,
      "serviceTag": "4577-7924-6610-3168-2590-1337-74",
      "cpu": "Intel Core i7-3520M CPU @ 2.90GHz",
      "cpuSpeed": 2893,
      "cpuCores": 4,
      "diskSize": 135,
      "diskFree": 84,
      "diskStatus": "OK",
      "memory": 2147,
      "noMonitors": 1,
      "monitorResolution": "1024x768",
      "bitlockerEnabled": true,
      "isCompliant": true,
      "tpmEnabled": true,
      "tpmVersion": "2.0"
    },
    "network": {
      "publicIP": "10.20.30.40",
      "privateIP": "10.10.129.52",
      "macAddress": "AF:4F:E3:23:62:E1",
      "nicSpeed": "1000 mbit",
      "hostName": "internal.acme.dk"
    },
    "location": {
      "city": "San Francisco",
      "region": "California",
      "country": "Unites States",
      "latitude": "37.7576948",
      "longitude": "122.4727052",
      "googleMapsLink": "https://maps.google.com/?q=37.7576948,122.4727052",
      "hourOffset": 8
    },
    "software": [
      {
        "name": "Admin By Request Workstation",
        "version": "8.0.0.0",
        "vendor": "FastTrack Software",
        "installDate": "2023-02-01T00:00:00",
        "size": 2,
        "bits": 64
      },
      {
        "name": "Adobe Acrobat Reader DC",
        "version": "20.006.20042",
        "vendor": "Adobe Systems Incorporated",
        "installDate": "2020-04-01T00:00:00"
      },
      {
        "name": "Microsoft Office 365 ProPlus - en-us",
        "version": "16.0.11929.20648",
        "vendor": "Microsoft Corporation",
        "installDate": null
      },
      {
        "name": "Mozilla Firefox 67.0.1 (x86 en-US)",
        "version": "67.0.1",
        "vendor": "Mozilla",
        "installDate": null
      },
      {
        "name": "OPSWAT Client",
        "version": "7.6.271.0",
        "vendor": "OPSWAT, Inc.",
        "installDate": null
      },
      {
        "name": "Visual Studio Community 2019",
        "version": "16.4.29709.97",
        "vendor": "Microsoft Corporation",
        "installDate": "2020-01-19T00:00:00"
      }
    ]
  }
]

Example without Inventory

				
					[
  {
    "name": "W10405945",
    "inventoryAvailable": false,
    "abrClientVersion": "6.3.0",
    "abrClientInstallDate": "2020-03-27T08:15:32",
    "user": null,
    "computer": null,
    "operatingSystem": null,
    "hardware": null,
    "network": null,
    "location": null,
    "software": null
  }
]