Inventory API

This page provides a reference of the available operations in the Inventory API.

All operations must be prefixed with the correct datacenter URL for your tenant. All requests must be authenticated via an API key.

The following operations are available:

Get inventory

Returns an array of computers with their inventory information.

Request

GET {datacenter}/inventory

Name Description Type

apikey

The API key for connecting to your tenant.

String

All parameters can alternatively be passed as headers. All parameters are optional.

Name Description Type

wantsoftware

If set to "true", return the software installed on the computer.

Default: "false"

Boolean

wantgroups

If set to "true", return the Active Directory or Entra ID groups of the user and the computer.

Default: "false"

Boolean

startid

The ID of the first computer to fetch. Can be used for incremental data retrieval.

Default: The first available ID.

Integer

take

The maximum number of computers to return.

Default: 50

Maximum: 10000. If you need to fetch more than 10000 computers, use pagination (see startid).

Warning: Do not consistently set this parameter to high numbers. If you do, you will quickly exceed your quota, and your account will be blocked for the rest of the day.

Integer
Response
200 - OK - Success response

The operation returns an array of JSON objects. Each object corresponds to one computer.

Name Description Type

id

The unique ID of the computer.

Integer

name

The name of the computer.

String

inventoryAvailable

Indicates whether inventory information is collected for this computer. Privacy settings may prevent the collection of inventory information.

Boolean

inventoryDate

The date and time when the inventory was last collected.

String, dateTime

abrClientVersion

The installed version of the Admin By Request client on the computer.

String

abrClientInstallDate

The date and time when the current version of the Admin By Request client was installed on the computer.

String, dateTime

notes

Notes or comments on the computer, as entered in the portal.

String

user

Information about the last user who logged in to the computer.

Object

account

The login name of the user.

String

fullName

The full name of the user.

String

email

The user's email address, as supplied by the user on a request form.

String

phone

The user's phone number, as supplied by the user on a request form.

String

isAdmin

Indicates whether the user is a local administrator on the computer.

Boolean

domain

The user's Active Directory login domain, if any.

String

isDomainJoined

Indicates whether the user account is an Active Directory account.

Boolean

isAzureJoined

Indicates whether the user account is an Entra ID (Azure AD) account.

Boolean

orgUnit

The name of the user's organizational unit in Active Directory (the last node in the tree).

String

orgUnitPath

The full path of the user's organizational unit in Active Directory.

String

groups

The Active Directory or Entra ID groups the user is a member of.

Only returned if wantgroups is set to "true". Otherwise null.

Array of strings

owner

Information about the owner of the computer. See Set device owner.

Object

account

The login name of the owner.

String

fullName

The full name of the owner.

String

computer

Information about the computer's directory membership and accounts.

Object

domain

The computer's Active Directory domain, if any.

String

isDomainJoined

Indicates whether the computer is joined to Active Directory.

Boolean

isAzureJoined

Indicates whether the computer is joined to Entra ID (Azure AD).

Boolean

orgUnit

The name of the computer's organizational unit in Active Directory (the last node in the tree).

String

orgUnitPath

The full path of the computer's organizational unit in Active Directory.

String

groups

The Active Directory or Entra ID groups the computer is a member of.

Only returned if wantgroups is set to "true". Otherwise null.

Array of strings

localAdmins

The accounts that are members of the local administrators group on the computer.

Array of strings

users

The user accounts on the computer. This field is only populated on computers with platform = "Mac". Other platforms return an empty array.

Array of strings

operatingSystem

Information about the operating system of the computer.

Object

platform

The operating system platform. Possible values are:

  • Windows

  • Mac

  • Server

String, enum

platformCode

The operating system platform. Possible values are:

  • 0: Windows

  • 1: Mac

  • 2: Server

Integer, enum

name

The name of the operating system, for example "Windows 11 Pro".

String

version

The version of the operating system, for example "22H2".

String

release

The release ID of the operating system (Windows 10 and newer).

Integer

build

The build number of the operating system.

Integer

buildUpdate

The update revision of the build (Windows 10 and newer).

Integer

type

The type of the operating system. Possible values are:

  • Workstation

  • Server

String, enum

typeCode

The type of the operating system. Possible values are:

  • 0: Workstation

  • 1: Server

Integer, enum

bits

The bitness of the operating system. Possible values are:

  • 32

  • 64

Integer, enum

installDate

The date when the operating system was installed.

String, dateTime

hardware

Information about the hardware of the computer.

Object

make

The manufacturer of the computer.

String

model

The model of the computer.

String

type

The type of the computer. Possible values are:

  • Portable

  • Desktop

String, enum

typeCode

The type of the computer. Possible values are:

  • 0: Portable

  • 1: Desktop

Integer, enum

serviceTag

The service tag (serial number) of the computer.

String

cpu

The name and model of the CPU.

String

cpuSpeed

The CPU speed in MHz.

Integer

cpuCores

The number of CPU cores.

Integer

diskSize

The size of the primary disk in GB.

Integer

diskFree

The free space on the primary disk in GB.

Integer

diskStatus

The S.M.A.R.T. status of the primary disk.

String

memory

The amount of memory in MB.

Integer

noMonitors

The number of monitors.

Integer

monitorResolution

The resolution of the primary monitor.

String

teamViewerID

The TeamViewer ID of the computer, if TeamViewer is installed.

String

bitlockerEnabled

Indicates whether BitLocker is enabled.

Boolean

isCompliant

Indicates whether the computer is compliant in Microsoft Intune. null if the information is not available.

Boolean

tpmEnabled

Indicates whether a Trusted Platform Module (TPM) is enabled.

Boolean

tpmVersion

The version of the Trusted Platform Module (TPM).

String

network

Information about the fastest active network adapter of the computer.

Object

publicIP

The public IP address.

String

privateIP

The private IP address.

String

macAddress

The MAC address.

String

nicSpeed

The speed of the network adapter, for example "1000 mbit".

String

hostName

The public host name.

String

location

Information about the location of the computer.

Object

city

The city.

String

region

The region.

String

country

The country.

String

latitude

The latitude.

String

longitude

The longitude.

String

googleMapsLink

A link to the location on Google Maps.

String

hourOffset

The offset in hours from Coordinated Universal Time (UTC).

Integer

software

The software installed on the computer. Each array element describes one application.

Only returned if wantsoftware is set to "true". Otherwise null.

Array of objects

name

The name of the application.

String

version

The version of the application.

String

vendor

The vendor of the application.

String

installDate

The date when the application was installed.

String, dateTime

size

The size of the application in MB.

Integer

bits

The bitness of the application (32 or 64).

Integer, enum
Example

Request: GET https://dc1api.adminbyrequest.com/inventory?wantsoftware=true&take=1

Response (the software list is shortened):

Copy 
[
    {
        "id": 49908054,
        "name": "WIN0815",
        "inventoryAvailable": true,
        "inventoryDate": "2026-10-28T13:24:27.65",
        "abrClientVersion": "9.0.0",
        "abrClientInstallDate": "2026-10-02T02:12:25",
        "notes": null,
        "user": {
            "account": "jdoe",
            "fullName": "John Doe",
            "email": "jdoe@acme.com",
            "phone": "12345678",
            "isAdmin": false,
            "domain": null,
            "isDomainJoined": false,
            "isAzureJoined": false,
            "orgUnit": null,
            "orgUnitPath": null,
            "groups": null
        },
        "owner": {
            "account": "jdoe",
            "fullName": "John Doe"
        },
        "computer": {
            "domain": null,
            "isDomainJoined": false,
            "isAzureJoined": false,
            "orgUnit": null,
            "orgUnitPath": null,
            "groups": null,
            "localAdmins": [
                "Admin",
                "Administrator"
            ],
            "users": []
        },
        "operatingSystem": {
            "platform": "Windows",
            "platformCode": 0,
            "name": "Windows 11 Enterprise",
            "version": "22H2",
            "release": 2009,
            "build": 22621,
            "buildUpdate": 6060,
            "type": "Workstation",
            "typeCode": 0,
            "bits": 64,
            "installDate": "2026-10-02T00:00:00"
        },
        "hardware": {
            "make": "Microsoft Corporation",
            "model": "Virtual Machine",
            "type": "Portable",
            "typeCode": 0,
            "serviceTag": "5655-1234-5678-9012-7909-7595-44",
            "cpu": "AMD Ryzen AI 7 PRO 350 w/ Radeon 860M",
            "cpuSpeed": 1996,
            "cpuCores": 8,
            "diskSize": 133,
            "diskFree": 49,
            "diskStatus": "OK",
            "memory": 4293,
            "noMonitors": 1,
            "monitorResolution": "1024x768",
            "teamViewerID": null,
            "bitlockerEnabled": false,
            "isCompliant": null,
            "tpmEnabled": false,
            "tpmVersion": null
        },
        "network": {
            "publicIP": "111.222.333.10",
            "privateIP": "172.11.22.33",
            "macAddress": "33:44:6A:7D:88:99",
            "nicSpeed": "10000 mbit",
            "hostName": null
        },
        "location": {
            "city": "Aalborg",
            "region": null,
            "country": "Denmark",
            "latitude": "57.0421",
            "longitude": "9.9145",
            "googleMapsLink": "https://maps.google.com/?q=57.0421,9.9145",
            "hourOffset": 1
        },
        "software": [
            {
                "name": "Admin By Request Workstation",
                "version": "9.0.0.0",
                "vendor": "FastTrack Software",
                "installDate": "2026-10-02T00:00:00",
                "size": 5,
                "bits": 32
            },
            {
                "name": "Git",
                "version": "2.56.0.3",
                "vendor": "The Git Development Community",
                "installDate": "2026-10-26T00:00:00",
                "size": 342,
                "bits": 64
            },
            {
                "name": "Microsoft Visual Studio Installer",
                "version": "3.10.2157.28521",
                "vendor": "Microsoft Corporation",
                "installDate": "2024-07-24T00:00:00",
                "size": null,
                "bits": 64
            }
        ]
    }
]

Get computer inventory

Returns the inventory information of a single computer, specified by ID or by computer name.

Request

GET {datacenter}/inventory/{id}

GET {datacenter}/inventory/{computername}

Name Description Type

apikey

The API key for connecting to your tenant.

String

All parameters can alternatively be passed as headers. All parameters are optional.

Name Description Type

wantsoftware

If set to "true", return the software installed on the computer.

Default: "false"

Boolean

wantgroups

If set to "true", return the Active Directory or Entra ID groups of the user and the computer.

Default: "false"

Boolean
Name Description Type

id

The ID of the computer to retrieve.

Integer

computername

The name of the computer. Not case-sensitive.

Can be used instead of id.

String
Response
200 - OK - Success response

The operation returns the specified computer as a JSON object.

Name Description Type

id

The unique ID of the computer.

Integer

name

The name of the computer.

String

inventoryAvailable

Indicates whether inventory information is collected for this computer. Privacy settings may prevent the collection of inventory information.

Boolean

inventoryDate

The date and time when the inventory was last collected.

String, dateTime

abrClientVersion

The installed version of the Admin By Request client on the computer.

String

abrClientInstallDate

The date and time when the current version of the Admin By Request client was installed on the computer.

String, dateTime

notes

Notes or comments on the computer, as entered in the portal.

String

user

Information about the last user who logged in to the computer.

Object

account

The login name of the user.

String

fullName

The full name of the user.

String

email

The user's email address, as supplied by the user on a request form.

String

phone

The user's phone number, as supplied by the user on a request form.

String

isAdmin

Indicates whether the user is a local administrator on the computer.

Boolean

domain

The user's Active Directory login domain, if any.

String

isDomainJoined

Indicates whether the user account is an Active Directory account.

Boolean

isAzureJoined

Indicates whether the user account is an Entra ID (Azure AD) account.

Boolean

orgUnit

The name of the user's organizational unit in Active Directory (the last node in the tree).

String

orgUnitPath

The full path of the user's organizational unit in Active Directory.

String

groups

The Active Directory or Entra ID groups the user is a member of.

Only returned if wantgroups is set to "true". Otherwise null.

Array of strings

owner

Information about the owner of the computer. See Set device owner.

Object

account

The login name of the owner.

String

fullName

The full name of the owner.

String

computer

Information about the computer's directory membership and accounts.

Object

domain

The computer's Active Directory domain, if any.

String

isDomainJoined

Indicates whether the computer is joined to Active Directory.

Boolean

isAzureJoined

Indicates whether the computer is joined to Entra ID (Azure AD).

Boolean

orgUnit

The name of the computer's organizational unit in Active Directory (the last node in the tree).

String

orgUnitPath

The full path of the computer's organizational unit in Active Directory.

String

groups

The Active Directory or Entra ID groups the computer is a member of.

Only returned if wantgroups is set to "true". Otherwise null.

Array of strings

localAdmins

The accounts that are members of the local administrators group on the computer.

Array of strings

users

The user accounts on the computer. This field is only populated on computers with platform = "Mac". Other platforms return an empty array.

Array of strings

operatingSystem

Information about the operating system of the computer.

Object

platform

The operating system platform. Possible values are:

  • Windows

  • Mac

  • Server

String, enum

platformCode

The operating system platform. Possible values are:

  • 0: Windows

  • 1: Mac

  • 2: Server

Integer, enum

name

The name of the operating system, for example "Windows 11 Pro".

String

version

The version of the operating system, for example "22H2".

String

release

The release ID of the operating system (Windows 10 and newer).

Integer

build

The build number of the operating system.

Integer

buildUpdate

The update revision of the build (Windows 10 and newer).

Integer

type

The type of the operating system. Possible values are:

  • Workstation

  • Server

String, enum

typeCode

The type of the operating system. Possible values are:

  • 0: Workstation

  • 1: Server

Integer, enum

bits

The bitness of the operating system. Possible values are:

  • 32

  • 64

Integer, enum

installDate

The date when the operating system was installed.

String, dateTime

hardware

Information about the hardware of the computer.

Object

make

The manufacturer of the computer.

String

model

The model of the computer.

String

type

The type of the computer. Possible values are:

  • Portable

  • Desktop

String, enum

typeCode

The type of the computer. Possible values are:

  • 0: Portable

  • 1: Desktop

Integer, enum

serviceTag

The service tag (serial number) of the computer.

String

cpu

The name and model of the CPU.

String

cpuSpeed

The CPU speed in MHz.

Integer

cpuCores

The number of CPU cores.

Integer

diskSize

The size of the primary disk in GB.

Integer

diskFree

The free space on the primary disk in GB.

Integer

diskStatus

The S.M.A.R.T. status of the primary disk.

String

memory

The amount of memory in MB.

Integer

noMonitors

The number of monitors.

Integer

monitorResolution

The resolution of the primary monitor.

String

teamViewerID

The TeamViewer ID of the computer, if TeamViewer is installed.

String

bitlockerEnabled

Indicates whether BitLocker is enabled.

Boolean

isCompliant

Indicates whether the computer is compliant in Microsoft Intune. null if the information is not available.

Boolean

tpmEnabled

Indicates whether a Trusted Platform Module (TPM) is enabled.

Boolean

tpmVersion

The version of the Trusted Platform Module (TPM).

String

network

Information about the fastest active network adapter of the computer.

Object

publicIP

The public IP address.

String

privateIP

The private IP address.

String

macAddress

The MAC address.

String

nicSpeed

The speed of the network adapter, for example "1000 mbit".

String

hostName

The public host name.

String

location

Information about the location of the computer.

Object

city

The city.

String

region

The region.

String

country

The country.

String

latitude

The latitude.

String

longitude

The longitude.

String

googleMapsLink

A link to the location on Google Maps.

String

hourOffset

The offset in hours from Coordinated Universal Time (UTC).

Integer

software

The software installed on the computer. Each array element describes one application.

Only returned if wantsoftware is set to "true". Otherwise null.

Array of objects

name

The name of the application.

String

version

The version of the application.

String

vendor

The vendor of the application.

String

installDate

The date when the application was installed.

String, dateTime

size

The size of the application in MB.

Integer

bits

The bitness of the application (32 or 64).

Integer, enum
500 - Internal Server Error - Unknown computer

No computer with the specified ID or name exists. The response message is "Unknown computer".

Example

Request: GET https://dc1api.adminbyrequest.com/inventory/WIN0815?wantgroups=true

Response:

Copy 
{
    "id": 49908054,
    "name": "WIN0815",
    "inventoryAvailable": true,
    "inventoryDate": "2026-10-28T13:24:27.65",
    "abrClientVersion": "9.0.0",
    "abrClientInstallDate": "2026-10-02T02:12:25",
    "notes": null,
    "user": {
        "account": "jdoe",
        "fullName": "John Doe",
        "email": "jdoe@acme.com",
        "phone": "12345678",
        "isAdmin": false,
        "domain": "ACME",
        "isDomainJoined": true,
        "isAzureJoined": false,
        "orgUnit": "Users",
        "orgUnitPath": "\\Users",
        "groups": [
            "Domain Users",
            "Users"
        ]
    },
    "owner": {
        "account": "jdoe",
        "fullName": "John Doe"
    },
    "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 Enterprise",
        "version": "22H2",
        "release": 2009,
        "build": 22621,
        "buildUpdate": 6060,
        "type": "Workstation",
        "typeCode": 0,
        "bits": 64,
        "installDate": "2026-10-02T00:00:00"
    },
    "hardware": {
            "make": "Microsoft Corporation",
            "model": "Virtual Machine",
            "type": "Portable",
            "typeCode": 0,
            "serviceTag": "5655-1234-5678-9012-7909-7595-44",
            "cpu": "AMD Ryzen AI 7 PRO 350 w/ Radeon 860M",
            "cpuSpeed": 1996,
            "cpuCores": 8,
            "diskSize": 133,
            "diskFree": 49,
            "diskStatus": "OK",
            "memory": 4293,
            "noMonitors": 1,
            "monitorResolution": "1024x768",
            "teamViewerID": null,
            "bitlockerEnabled": false,
            "isCompliant": null,
            "tpmEnabled": false,
            "tpmVersion": null
        },
    "network": {
        "publicIP": "111.222.333.10",
        "privateIP": "172.11.22.33",
        "macAddress": "33:44:6A:7D:88:99",
        "nicSpeed": "10000 mbit",
        "hostName": null
        },
    "location": {
        "city": "Aalborg",
        "region": null,
        "country": "Denmark",
        "latitude": "57.0421",
        "longitude": "9.9145",
        "googleMapsLink": "https://maps.google.com/?q=57.0421,9.9145",
        "hourOffset": 1
    },
    "software": null
}

Delete computer

Deletes a computer, specified by ID or by computer name, from the inventory.

Request

DELETE {datacenter}/inventory/{id}

DELETE {datacenter}/inventory/{computername}

Name Description Type

apikey

The API key for connecting to your tenant.

String
Name Description Type

id

The ID of the computer to delete.

Integer

computername

The name of the computer. Not case-sensitive.

Can be used instead of id.

String
Response
200 - OK - Success response

The operation returns true.

500 - Internal Server Error - Unknown computer

No computer with the specified ID or name exists. The response message is "Unknown computer".

Clear device owner

Removes the device owner from a computer, specified by ID or by computer name. If the computer has no owner, nothing happens.

Request

DELETE {datacenter}/inventory/{id}/owner

DELETE {datacenter}/inventory/{computername}/owner

Name Description Type

apikey

The API key for connecting to your tenant.

String
Name Description Type

id

The ID of the computer.

Integer

computername

The name of the computer. Not case-sensitive.

Can be used instead of id.

String
Response
200 - OK - Success response

The operation returns true.

Set device owner

Sets the device owner of a computer, specified by ID or by computer name. If the computer already has an owner, the owner is replaced.

Request

POST {datacenter}/inventory/{id}/owner

POST {datacenter}/inventory/{computername}/owner

Name Description Type

apikey

The API key for connecting to your tenant.

String
Name Description Type

id

The ID of the computer.

Integer

computername

The name of the computer. Not case-sensitive.

Can be used instead of id.

String

A JSON object with the following properties. All properties are required. Send the body with the header Content-Type: application/json.

Name Description Type

sid

The security identifier (SID) of the user to set as owner.

String

accountName

The account name of the user to set as owner.

String

fullName

The full name of the user to set as owner.

String
Response
200 - OK - Success response

The operation returns true.

Example

Request: POST https://dc1api.adminbyrequest.com/inventory/WIN0815/owner

Request body:

Copy 
{
    "sid": "S-1-5-21-XXXXXXXXXX-XXXXXXXXXX-XXXXXXXXXX-XXXX",
    "accountName": "jdoe",
    "fullName": "John Doe"
}

Response: true

Get PIN code

Generates a PIN code for a computer, specified by ID or by computer name. You can generate two types of PIN code:

  • Challenge/response PIN: When a user on an offline computer needs an approval, they can request a PIN code. The client displays a 6-digit PIN 1, which the user passes on to the help desk. The help desk uses this operation to generate the matching 6-digit PIN 2, which the user enters on the computer. PIN 2 depends on PIN 1, the tenant and the computer, so the same PIN 1 results in a different PIN 2 on a different computer.

  • Uninstall PIN: A 10-digit PIN code that allows uninstalling Admin By Request from the computer. Each call generates a new PIN code.

Request

GET {datacenter}/inventory/{id}/pin

GET {datacenter}/inventory/{computername}/pin

Name Description Type

apikey

The API key for connecting to your tenant.

String
Name Description Type

id

The ID of the computer.

Integer

computername

The name of the computer. Not case-sensitive.

Can be used instead of id.

String

All parameters can alternatively be passed as headers.

Name Description Type

pintype

The type of PIN code to generate. Not case-sensitive. Allowed values are:

  • challenge: Generate a challenge/response PIN 2 for the PIN 1 passed in pin1.

  • uninstallpin: Generate an uninstall PIN.

Any other value is treated as challenge.

Default: "challenge"

String, enum

pin1

The 6-digit PIN 1 displayed on the computer.

Required if pintype is challenge. Ignored if pintype is uninstallpin.

String
Response
200 - OK - Success response

The operation returns the PIN code as a JSON string: a 6-digit PIN 2 for challenge, or a 10-digit uninstall PIN for uninstallpin.

500 - Internal Server Error - General error

No computer with the specified ID or name exists, or pin1 is missing or is not a 6-digit number. The response message is "General error".

Examples

Request: GET https://dc1api.adminbyrequest.com/inventory/WIN0815/pin?pintype=challenge&pin1=123456

Response: "583104"

Request: GET https://dc1api.adminbyrequest.com/inventory/WIN0815/pin?pintype=uninstallpin

Response: "3907461528"