Skip to main content

Custom Fields

Custom fields let you attach typed metadata to devices — serial numbers, hardware versions, geographic coordinates, feature flags, or any domain-specific data.

Define custom fields​

Custom fields are defined at the workspace level only. Go to Devices → Custom Fields to manage definitions.

POST /workspaces/{workspace_id}/devices/custom-fields
Content-Type: application/json

{
  "name": "serial_number",
  "type": "string",
  "required": true
}

Set values on a device​

When creating or editing a device, fill in the custom field values. Required fields must be provided at creation time.

Use custom fields for filtering​

In the device list, filter devices by custom field values — e.g. show all devices with hardware_version = "v2".

API​