List Devices

Returns a paginated list of all devices in the specified workspace.

Endpoint

GET /rest/v1/workspaces/{workspace_uuid}/devices

Headers

Header	Value
Authorization	Bearer <YOUR_API_KEY>
Content-Type	application/json

Path Parameters

Parameter	Type	Required	Description
workspace_uuid	String	Yes	Unique identifier of the workspace.

Query Parameters

Parameter	Type	Required	Description
search	String	No	Search devices by name or identifier.
page	Integer	No	Page number to retrieve. Default: 1.
per_page	Integer	No	Number of devices to return per page. Default: 20. Maximum: 50.

Example Request

GET /rest/v1/workspaces/01kxcxpcgvdm1pacpfv1wxqqeh/devices?page=1&per_page=20
Authorization: Bearer <YOUR_API_KEY>

Success Response

Status: 200 OK

{
  "data": [
    {
      "uuid": "01kxcy4ga5350mb3jwbp9f7hj4",
      "name": "Test",
      "identifier": "TEST",
      "description": "Test device",
      "enabled_transformation": false,
      "transformation_script": "return JSON.stringify(payload);",
      "created_at": "2026-07-13T05:10:27.90936Z",
      "updated_at": "2026-07-13T05:10:27.90936Z"
    },
    {
      "uuid": "01kwbqcafvwxqdgqrpr8694e7r",
      "name": "PLANT",
      "identifier": "PLANT",
      "description": "PLANT",
      "enabled_transformation": false,
      "transformation_script": "return JSON.stringify(payload);",
      "created_at": "2026-06-30T07:37:27.803448Z",
      "updated_at": "2026-06-30T07:37:27.803448Z"
    }
  ],
  "meta": {
    "count": 2,
    "message": "Devices fetched successfully",
    "page": 1,
    "per_page": 20,
    "success": true
  }
}

Response Fields

Field	Description
uuid	Unique identifier of the device.
name	Name of the device.
identifier	Unique identifier used to reference the device within the workspace.
description	Description of the device.
enabled_transformation	Indicates whether payload transformation is enabled for the device.
transformation_script	Transformation script used to process incoming device payloads before ingestion.
created_at	Timestamp when the device was created (UTC).
updated_at	Timestamp of the most recent update (UTC).