Skip to main content
GET
Search CoworkerInventoryAssets
A customer equipment assignment links one customer to one equipment item at a location, with a required start and optional end date; use it for assignment history, planned returns, or notes rather than editing the equipment item’s read-only assignment summaries.

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 customer receiving the equipment item; the customer must be accessible to the current user..
string
Filter by display value for Coworker.CoworkerType..
string
Filter by display value for Coworker.FullName..
string
Filter by display value for Coworker.BillingName..
string
Filter by display value for Coworker.CompanyName..
string
Filter by display value for Coworker.TeamNames..
integer
Filter by iD of the location where this customer equipment assignment applies..
integer
Filter by iD of the equipment item assigned to the customer; a customer cannot have more than one active assignment for the same item..
string
Filter by display value for InventoryAsset.Name..
string
Filter by display value for InventoryAsset.Sku..
number
Filter by display value for InventoryAsset.Value..
string
Filter by display value for InventoryAsset.UniqueId..
string
Filter by optional internal notes about this customer equipment assignment..
string
Filter by required assignment start date and time; the server rejects the record when it is not supplied..
string
Filter by optional assignment end date and time, which cannot be earlier than AssignedFrom; null keeps the assignment active..

Range Filters

number
Filter by display value for InventoryAsset.Value. greater than or equal to this value.
number
Filter by display value for InventoryAsset.Value. less than or equal to this value.
string
Filter by required assignment start date and time; the server rejects the record when it is not supplied. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by required assignment start date and time; the server rejects the record when it is not supplied. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by optional assignment end date and time, which cannot be earlier than AssignedFrom; null keeps the assignment active. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by optional assignment end date and time, which cannot be earlier than AssignedFrom; null keeps the assignment active. 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.
Partial records — The listing endpoint returns a summary representation of each CoworkerInventoryAsset. The following fields are not populated in the Records[] response: Notes.To get all fields, fetch the full record using the Get one CoworkerInventoryAsset 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