Devices
GET works with READ. Creating, updating, or deleting devices requires WRITE (Authentication & scopes).
What a “device” represents
Section titled “What a “device” represents”Each record represents hardware tracked in your workspace: identity, assignment, lifecycle status, technical characteristics (CPU, RAM, optional keyboard layout), and optional MDM metadata.
Listing and filtering
Section titled “Listing and filtering”You can paginate and filter by free-text search, assignee user id, and client status. This is usually enough for inventory views, support queues, and dashboards.
Batch creation
Section titled “Batch creation”New hardware is created in batches: the request body contains an array of device payloads. Each item needs the minimum identity fields (name, type, category). Optional fields cover purchase/rental metadata, specs, and assignment.
Updates and soft delete
Section titled “Updates and soft delete”PATCH updates only provided fields. Omit fields you do not want to change.
DELETE performs a soft delete. Some device states cannot be mutated (for example DEVICE_MUTATION_FORBIDDEN).
Keyboard layout
Section titled “Keyboard layout”When a device has a keyboard layout, it uses the same enum values as catalog and cart line items.
Next steps
Section titled “Next steps”- Catalog — where catalog products and layout choices originate.
- API reference — Devices tag for paths, bodies, and error codes.