CoworkerInventoryAssets
Search CoworkerInventoryAssets
Search and list CoworkerInventoryAsset records with filtering, sorting, and pagination.
GET
Search CoworkerInventoryAssets
A CoworkerInventoryAsset tracks inventory assets — such as chairs, desks, monitors, or other physical items — that have been assigned to a customer.
Each record links a
Coworker to an InventoryAsset at a specific Business (location), with an assignment period defined by AssignedFrom and optionally AssignedTo. If AssignedTo is null, the asset is still assigned to the customer.
Read-only fields prefixed with Coworker* and InventoryAsset* are denormalized from the linked coworker and inventory asset records for convenience when listing or filtering.
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 CoworkerInventoryAsset-List role.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 coworker linked to this record.
string
Filter by type of the linked coworker (e.g. Member, Team Member).
string
Filter by full name of the linked coworker.
string
Filter by billing name of the linked coworker.
string
Filter by company name of the linked coworker.
string
Filter by comma-separated team names the linked coworker belongs to.
integer
Filter by iD of the business linked to this record.
integer
Filter by iD of the inventory asset linked to this record.
string
Filter by name of the linked inventory asset.
string
Filter by sKU code of the linked inventory asset.
string
Filter by monetary value of the linked inventory asset.
string
Filter by unique identifier (e.g. serial number) of the linked inventory asset.
string
Filter by free-text notes about this asset assignment.
string
Filter by date the asset was assigned to the customer.
string
Filter by date the asset assignment ends. Null if still assigned.
Range Filters
string
Filter by date the asset was assigned to the customer greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by date the asset was assigned to the customer less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by date the asset assignment ends. Null if still assigned greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by date the asset assignment ends. Null if still assigned less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.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 CreatedOn
Range filters
Response
200
CoworkerInventoryAsset[]
The list of CoworkerInventoryAsset records matching the query. See the Get one CoworkerInventoryAsset 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
Search CoworkerInventoryAssets