Devices
Manage the devices and assets belonging to a customer
A device (or asset) is something a customer brings in for service — a laptop, a
vehicle, an appliance. Devices live under a customer as a subcollection, and a
job references one via its deviceId.
Beyond the fixed fields (type, brand, make, model), a device accepts
arbitrary extra keys — send a serial or identifier and it is stored and
returned as-is.
Editing a device updates its jobs
Updating a device propagates its type and display name onto every job that
references it (the customerDeviceType and customerDeviceName fields).
Deleting a device clears the deviceId reference from any job that used it,
but leaves the historical device name on those jobs untouched.
Required scopes: devices:read / devices:write / devices:delete.
Endpoints
- GET
/organisations/{orgId}/customers/{customerId}/devices— List a customer's devices - POST
/organisations/{orgId}/customers/{customerId}/devices— Create device - GET
/organisations/{orgId}/customers/{customerId}/devices/{deviceId}— Get device - PUT
/organisations/{orgId}/customers/{customerId}/devices/{deviceId}— Update device - DELETE
/organisations/{orgId}/customers/{customerId}/devices/{deviceId}— Delete device
Machine-readable version: OpenAPI spec.