Items
Read your equipment, its field values, inspection frequencies and history.
An item (item_…) is one piece of equipment in your inventory. The manufacturer API knows the same item as serial_…, and the item routes accept either identifier.
List items with List items and read one with Retrieve an item. Items need the items:read scope.
What an item carries
status: its safety status, such assafe_passedornot_safe_overdue.productandsku: what the item is, with the manufacturer and part number. Both arenullfor an item with no catalogue match.folder: the folder that holds it, as{ id, name }, ornullat the top level. See Folders.assigned_to: the member it is assigned to, as{ id, name }, ornull.labels: your labels on it, each as{ id, name }. See Labels.last_inspection: its latest inspection'sid,status,type,inspected_atandnotes, ornullif it has never been inspected.- Dates:
manufactured_at,first_used_at,expires_atandnext_inspection_at.
Retrieving one item also returns the fields below. The list adds them when you send include=data_fields,inspection_frequencies.
data_fields: the values of your organisation's own fields, only those set on this item, typed astext,number,boolean,dateorurl.internalfields show only to your organisation;publicones also show on the item's public page. File fields are left out.inspection_frequencies: the inspection frequencies applied to the item, each with when it is next due.
Finding items
Look an item up by serial_number, nfc_tag or text with q, and filter the list by status, folder, label, assignee, product, SKU and dates. See Filtering.
Archived items are left out unless you send archived=true. An archived item can still be retrieved by its identifier.
An API key sees every item in your organisation, whatever folder permissions say.
History
List the history of an item returns its events, newest first. From before your organisation began holding the item, only its inspections show, without who carried them out. Other organisations' labels and the manufacturer's own operations are left out, and a manufacturer's inspections show without the inspector.
Filter by kind of event with group: scans, inspections, usage_and_tasks, assignments, inventory, assembly or record.
performed_by names whoever acted, as { id, name }. Its id is null when they are not a member of your organisation, such as an outside inspector; name gives their name either way. performed_by is null when nobody is recorded.
Items have no updated_at: changes such as a move or a new label are recorded elsewhere than the item, so it would miss them. Use the history to see what changed.