Devices

Device endpoints are served from the API root with no /api prefix.

Endpoints

Method	Path	Description
GET	/devices	List devices visible to the caller
POST	/devices	Create a device
GET	/devices/:id	Get a device
PATCH	/devices/:id	Update a device
POST	/devices/:id/transfer	Move a device to another organization
DELETE	/devices/:id	Delete a device

List devices

GET /devices?orgId=<uuid>&status=online&q=site-alpha

Query parameters

Parameter	Type	Description
orgId	uuid	Limit to one organization
status	string	Filter by status (online, offline, provisioning, error, disabled)
q	string	Search by name, serial, model, or organization
tag	string	Filter by tag
cursor	string	Pagination cursor for the next page

The response includes items and a nextCursor for paging.

Create a device

POST /devices
Content-Type: application/json

{
  "organizationId": "<uuid>",
  "serial": "AABBCCDDEEFF",
  "name": "Site Alpha RC500",
  "model": "RC500",
  "tags": ["site-alpha"]
}

Requires the device:create scope. Creation is subject to your organization’s subscription status and device quota.

Update a device

PATCH /devices/:id
Content-Type: application/json

{
  "name": "Updated name",
  "tags": ["site-alpha", "priority"],
  "status": "disabled"
}

The serial is permanent and cannot be changed after creation.

Transfer a device

POST /devices/:id/transfer
Content-Type: application/json

{
  "toOrgId": "<uuid>",
  "reason": "handed to customer site"
}

Requires the device:transfer scope on both the source and destination organizations.

Delete a device

DELETE /devices/:id

Removes the device record and its history.

Error responses

Status	Meaning
400	Invalid request
401	Not authenticated
403	Insufficient permissions
404	Device not found
429	Rate limit exceeded