InventoryAssets
Search InventoryAssets
Search and list InventoryAsset records with filtering, sorting, and pagination.
GET
An InventoryAsset represents a physical asset — such as a desk, chair, monitor, printer, or other piece of equipment — that a location can track and optionally assign to customers.
Each asset belongs to a single location (
Assets may also be assigned to one or more coworkers. The read-only fields
BusinessId) and can be assigned to a specific scope via AssignToType:
| AssignToType value | Meaning |
|---|---|
| 1 (Location) | Assigned to the location generally, not tied to a specific resource or floor-plan item |
| 2 (Resource) | Linked to a bookable resource (e.g. a specific meeting room) via ResourceId |
| 3 (FloorPlanItem) | Linked to a floor-plan desk via FloorPlanDeskId |
CoworkerIds, CoworkerFullNames, CoworkerStartDates, and CoworkerEndDates reflect current assignments. To manage coworker-level assignments, use the CoworkerInventoryAsset entity instead.
Authentication
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
eInventoryAssetAssignToType — AssignToType values
eInventoryAssetAssignToType — AssignToType values
| Value | Name |
|---|---|
| 1 | Location |
| 2 | Resource |
| 3 | FloorPlanItem |
Query Parameters
Pagination & Sorting
The page number to retrieve.
The number of records per page.
The property name to sort results by (e.g.
Name, CreatedOn).Sort direction.
1 for ascending, -1 for descending.Filters
Filter by Business Id.
Filter by name of the location this asset belongs to.
Filter by display name of the asset (e.g. ‘Standing Desk #3’, ‘HP LaserJet’).
Filter by free-text description of the asset.
Filter by stock-keeping unit code for the asset.
Filter by Image File Name.
Filter by New Image Url.
Filter by Clear Image File.
Filter by monetary value of the asset.
Filter by Floor Plan Desk Id.
Filter by name of the linked floor-plan desk.
Filter by comma-separated full names of coworkers currently assigned to this asset.
Filter by comma-separated IDs of coworkers currently assigned to this asset.
Filter by comma-separated start dates of each coworker assignment.
Filter by comma-separated end dates of each coworker assignment.
Filter by Resource Id.
Filter by name of the linked bookable resource.
Filter by determines what this asset is assigned to: Location (1), Resource (2), or FloorPlanItem (3).
Range Filters
Filter by monetary value of the asset greater than or equal to this value.
Filter by monetary value of the asset less than or equal to this value.
Filter records created on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records created on or before this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or before this date. Format:
YYYY-MM-DDTHH:mm.Code Examples
Simple listing
Filtering by Name
Range filters
Response
200
The list of InventoryAsset records matching the query. See the Get one InventoryAsset endpoint for the full list of properties returned for each record.
Current page number.
Number of records per page.
The field used for sorting.
The sort direction (
1 = ascending, -1 = descending).Index of the first item on the current page.
Index of the last item on the current page.
Total number of matching records across all pages.
Total number of pages.
Whether there is a next page of results.
Whether there is a previous page of results.
Example Response