> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Search InventoryAssets

> Search and list InventoryAsset records with filtering, sorting, and pagination.

An InventoryAsset is a location-owned physical item, such as a desk, chair, monitor, or printer, tracked at the location, a bookable resource, or a floor-plan desk. Customer assignments are managed as separate CoworkerInventoryAsset records.

## Authentication

> [!NOTE]
>
> This endpoint requires OAuth2 authentication. Include a valid bearer token in the `Authorization` header.
> The authenticated user must be a full unrestricted administrator or have the **`InventoryAsset-List`** role.

## Enums

> [accordion] eInventoryAssetAssignToType — AssignToType values
>
> | Value | Name |
> | - | - |
> | 1 | Location |
> | 2 | Resource |
> | 3 | FloorPlanItem |

## Query Parameters

### Pagination & Sorting

**page** `integer` (default: 1)

The page number to retrieve.

**size** `integer` (default: 25)

The number of records per page.

**orderBy** `string`

The property name to sort results by (e.g. `Name`, `CreatedOn`).

**dir** `integer`

Sort direction. `0` for ascending, `1` for descending.

### Filters

**InventoryAsset\_Business** `integer`

Filter by iD of the location that owns this asset; saving a linked resource or floor-plan desk can replace it with that linked record's location..

**InventoryAsset\_Business\_Name** `string`

Filter by display value for Business.Name..

**InventoryAsset\_Name** `string`

Filter by required display name of the physical asset, such as 'Standing Desk #3' or 'HP LaserJet'..

**InventoryAsset\_Description** `string`

Filter by optional free-text description of the asset..

**InventoryAsset\_Sku** `string`

Filter by optional stock-keeping unit code; when provided, it must be unique within the location..

**InventoryAsset\_ImageFileName** `string`

Filter by current file name of the image (read-only; upload via the corresponding URL field).

**InventoryAsset\_NewImageUrl** `string`

Filter by uRL of a new file to upload as the image.

**InventoryAsset\_ClearImage** `boolean`

Filter by set to true to remove the current image file.

**InventoryAsset\_Value** `number`

Filter by optional monetary value of the asset in the owning location's currency..

**InventoryAsset\_FloorPlanDesk** `integer`

Filter by iD of the floor-plan desk linked to this asset; required when AssignToType is FloorPlanItem and it sets the asset's location from the desk's floor plan..

**InventoryAsset\_FloorPlanDesk\_Name** `string`

Filter by display value for FloorPlanDesk.Name..

**InventoryAsset\_CoworkerFullNames** `string`

Filter by read-only comma-separated customer names projected from CoworkerInventoryAsset assignment records; change assignments through that entity instead..

**InventoryAsset\_CoworkerIds** `string`

Filter by read-only comma-separated customer IDs projected from CoworkerInventoryAsset assignment records; change assignments through that entity instead..

**InventoryAsset\_CoworkerStartDates** `string`

Filter by read-only comma-separated assignment start dates projected from CoworkerInventoryAsset records; each assignment requires a start date..

**InventoryAsset\_CoworkerEndDates** `string`

Filter by read-only comma-separated assignment end dates projected from CoworkerInventoryAsset records; an end date cannot precede its assignment start date..

**InventoryAsset\_Resource** `integer`

Filter by iD of the bookable resource linked to this asset; required when AssignToType is Resource and it sets the asset's location to the resource's location..

**InventoryAsset\_Resource\_Name** `string`

Filter by display value for Resource.Name..

**InventoryAsset\_AssignToType** `integer`

Filter by determines the asset scope: Location (1) needs no linked resource or desk, Resource (2) requires ResourceId, and FloorPlanItem (3) requires FloorPlanDeskId..

### Range Filters

**from\_InventoryAsset\_Value** `number`

Filter by optional monetary value of the asset in the owning location's currency. greater than or equal to this value.

**to\_InventoryAsset\_Value** `number`

Filter by optional monetary value of the asset in the owning location's currency. less than or equal to this value.

**from\_InventoryAsset\_CreatedOn** `string`

Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.

**to\_InventoryAsset\_CreatedOn** `string`

Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.

**from\_InventoryAsset\_UpdatedOn** `string`

Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.

**to\_InventoryAsset\_UpdatedOn** `string`

Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.

## Code Examples

### Simple listing

```bash cURL theme={null}
curl -X GET \
  "https://spaces.nexudus.com/api/spaces/inventoryassets?page=1&size=15&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"
```

```javascript JavaScript theme={null}
const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/inventoryassets?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'Name',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();
```

```python Python theme={null}
import requests

response = requests.get(
    'https://spaces.nexudus.com/api/spaces/inventoryassets',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'Name',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()
```

### Filtering by Name

```bash cURL theme={null}
curl -X GET \
  "https://spaces.nexudus.com/api/spaces/inventoryassets?InventoryAsset_Name=example-value&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"
```

```javascript JavaScript theme={null}
const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/inventoryassets?' + new URLSearchParams({
    InventoryAsset_Name: 'example-value',
    orderBy: 'Name',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();
```

```python Python theme={null}
import requests

response = requests.get(
    'https://spaces.nexudus.com/api/spaces/inventoryassets',
    params={
        'InventoryAsset_Name': 'example-value',
        'orderBy': 'Name',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()
```

### Range filters

```bash cURL theme={null}
curl -X GET \
  "https://spaces.nexudus.com/api/spaces/inventoryassets?from_InventoryAsset_UpdatedOn=2025-01-01T00:00&to_InventoryAsset_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"
```

```javascript JavaScript theme={null}
const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/inventoryassets?' + new URLSearchParams({
    from_InventoryAsset_UpdatedOn: '2025-01-01T00:00',
    to_InventoryAsset_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();
```

```python Python theme={null}
import requests

response = requests.get(
    'https://spaces.nexudus.com/api/spaces/inventoryassets',
    params={
        'from_InventoryAsset_UpdatedOn': '2025-01-01T00:00',
        'to_InventoryAsset_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()
```

## Response

### 200

**Records** `InventoryAsset[]`

The list of InventoryAsset records matching the query. See the [Get one InventoryAsset](https://learn.nexudus.com/rest-api/spaces/get-inventoryassets-by-id.md) endpoint for the full list of properties returned for each record.

**CurrentPage** `integer`

Current page number.

**CurrentPageSize** `integer`

Number of records per page.

**CurrentOrderField** `string`

The field used for sorting.

**CurrentSortDirection** `integer`

The sort direction (`0` = ascending, `1` = descending).

**FirstItem** `integer`

Index of the first item on the current page.

**LastItem** `integer`

Index of the last item on the current page.

**TotalItems** `integer`

Total number of matching records across all pages.

**TotalPages** `integer`

Total number of pages.

**HasNextPage** `boolean`

Whether there is a next page of results.

**HasPreviousPage** `boolean`

Whether there is a previous page of results.

```json Example Response theme={null}
{
  "Records": [
    {
      "BusinessId": 0,
      "BusinessName": null,
      "Name": "",
      "Description": null,
      "Sku": null,
      "ImageFileName": null,
      "NewImageUrl": null,
      "ClearImageFile": null,
      "Value": null,
      "FloorPlanDeskId": null,
      "FloorPlanDeskName": null,
      "CoworkerFullNames": null,
      "CoworkerIds": null,
      "CoworkerStartDates": null,
      "CoworkerEndDates": null,
      "ResourceId": null,
      "ResourceName": null,
      "AssignToType": 0,
      "Id": 87654321,
      "UpdatedOn": "2025-01-15T10:30:00Z",
      "CreatedOn": "2025-01-10T08:00:00Z",
      "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "UpdatedBy": "admin@example.com",
      "IsNew": false,
      "SystemId": null,
      "ToStringText": "InventoryAsset Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.