InventoryAssets
Search InventoryAssets
Search and list InventoryAsset records with filtering, sorting, and pagination.
GET
Search InventoryAssets
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
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
Query Parameters
Pagination & Sorting
integer
default:"1"
The page number to retrieve.
integer
default:"25"
The number of records per page.
string
The property name to sort results by (e.g.
Name, CreatedOn).integer
Sort direction.
0 for ascending, 1 for descending.Filters
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..
string
Filter by display value for Business.Name..
string
Filter by required display name of the physical asset, such as ‘Standing Desk #3’ or ‘HP LaserJet’..
string
Filter by optional free-text description of the asset..
string
Filter by optional stock-keeping unit code; when provided, it must be unique within the location..
string
Filter by current file name of the image (read-only; upload via the corresponding URL field).
string
Filter by uRL of a new file to upload as the image.
boolean
Filter by set to true to remove the current image file.
number
Filter by optional monetary value of the asset in the owning location’s currency..
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..
string
Filter by display value for FloorPlanDesk.Name..
string
Filter by read-only comma-separated customer names projected from CoworkerInventoryAsset assignment records; change assignments through that entity instead..
string
Filter by read-only comma-separated customer IDs projected from CoworkerInventoryAsset assignment records; change assignments through that entity instead..
string
Filter by read-only comma-separated assignment start dates projected from CoworkerInventoryAsset records; each assignment requires a start date..
string
Filter by read-only comma-separated assignment end dates projected from CoworkerInventoryAsset records; an end date cannot precede its assignment start date..
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..
string
Filter by display value for Resource.Name..
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
number
Filter by optional monetary value of the asset in the owning location’s currency. greater than or equal to this value.
number
Filter by optional monetary value of the asset in the owning location’s currency. less than or equal to this value.
string
Filter records created on or after this date. Format:
YYYY-MM-DDTHH:mm.string
Filter records created on or before this date. Format:
YYYY-MM-DDTHH:mm.string
Filter records updated on or after this date. Format:
YYYY-MM-DDTHH:mm.string
Filter records updated on or before this date. Format:
YYYY-MM-DDTHH:mm.Code Examples
Simple listing
Filtering by Name
Range filters
Response
200
InventoryAsset[]
The list of InventoryAsset records matching the query. See the Get one InventoryAsset endpoint for the full list of properties returned for each record.
integer
Current page number.
integer
Number of records per page.
string
The field used for sorting.
integer
The sort direction (
0 = ascending, 1 = descending).integer
Index of the first item on the current page.
integer
Index of the last item on the current page.
integer
Total number of matching records across all pages.
integer
Total number of pages.
boolean
Whether there is a next page of results.
boolean
Whether there is a previous page of results.
Example Response