Sign in

v1

latestOpenAPI 3.1.02026-07-2489171167.4 KB
Assets

Get list of assets

Retrieves a list of assets.

get/assets

Query parameters

limitinteger

The number of records to return per page, up to 500.

offsetinteger

The offset for pagination. Calculated as (page - 1) * limit (page starts at 1).

sortBy'id' | 'name' | 'type' | 'manufacturer' | 'model' | 'serial' | 'ownerId' | 'source' | 'ownership' | 'companyId' | 'locationId' | 'departmentId' | 'updateTime' | 'warrantyExpiration'

An asset field to sort by.

sortDir'asc' | 'desc'

Assets sorting direction.

querystring

A string by which assets are searched. The search is made in the following asset properties: name, description and additionalData.

idstring[]

Assets id filter.

sourcestring[]

Assets source filter.

ownershipstring[]

Assets ownership filter

isDisabledboolean

Assets disablement status filter.

ownerIdinteger[]

Assets owner ids filter.

namestring

Assets name filter.

typestring

Assets type filter.

descriptionstring

Assets description filter.

ipAddressesstring

Assets IP addresses filter.

macAddressesstring

Assets MAC addresses filter

manufacturerstring

Assets manufacturer name filter.

modelstring

Assets model name filter.

serialstring

Assets model name filter.

companyIdinteger[]

Assets company id filter.

departmentIdinteger[]

Assets department id filter.

locationIdinteger[]

Assets location id filter.

Response

Returns a list of assets.

limitinteger

The number of items that are returned per page

offsetinteger

The offset used for pagination.

totalinteger

The total number of elements across all pages.

Example response

{
  "limit": 20,
  "total": 50,
  "data": [
    {
      "name": "KATANA-GF66",
      "type": "laptop",
      "source": "agent",
      "manufacturer": "MSI",
      "model": "GF66 11UG-871",
      "serial": "SN1A2B3C4",
      "description": "Very cool asset!",
      "ownerId": 10293,
      "ownership": "personal",
      "companyId": 7,
      "locationId": 14,
      "departmentId": 3,
      "warrantyExpiration": "2026-05-13",
      "patchManagementEnabled": true,
      "os": {
        "name": "Windows",
        "version": "11 Pro 24H2"
      },
      "network": {
        "macAddresses": [
          "18:3D:A2:55:67:10",
          "18:3D:A2:55:67:11"
        ],
        "ipAddresses": [
          "10.178.3.44",
          "10.178.3.45"
        ]
      },
      "customFields": {
        "cust_col1": "val1",
        "cust_col21": "val2"
      },
      "additionalData": "Uptime (in seconds): 23945770\nUser domain: EXAMPLE",
      "id": "MSI-123",
      "updateTime": "2025-07-27T18:09:55Z",
      "version": 1
    }
  ]
}