Skip to main content
GET
Search InventoryAssets
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 (BusinessId) and can be assigned to a specific scope via AssignToType: Assets may also be assigned to one or more coworkers. The read-only fields 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

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 business linked to this record.
string
Filter by name of the location this asset belongs to.
string
Filter by display name of the asset (e.g. ‘Standing Desk #3’, ‘HP LaserJet’).
string
Filter by free-text description of the asset.
string
Filter by stock-keeping unit code for the asset.
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 monetary value of the asset.
integer
Filter by iD of the floor plan desk linked to this record.
string
Filter by name of the linked floor-plan desk.
string
Filter by comma-separated full names of coworkers currently assigned to this asset.
string
Filter by comma-separated IDs of coworkers currently assigned to this asset.
string
Filter by comma-separated start dates of each coworker assignment.
string
Filter by comma-separated end dates of each coworker assignment.
integer
Filter by iD of the resource linked to this record.
string
Filter by name of the linked bookable resource.
integer
Filter by determines what this asset is assigned to: Location (1), Resource (2), or FloorPlanItem (3).

Range Filters

number
Filter by monetary value of the asset greater than or equal to this value.
number
Filter by monetary value of the asset 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.
Partial records — The listing endpoint returns a summary representation of each InventoryAsset. The following fields are not populated in the Records[] response: AssignToType.To get all fields, fetch the full record using the Get one InventoryAsset endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.
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