List Device Variables

Returns a paginated list of variables configured for the specified device.

Endpoint

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

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.
`device_uuid`	String	Yes	Unique identifier of the device.

Query Parameters

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

Example Request

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

Success Response

Status: 200 OK

{
  "data": [
    {
      "uuid": "01kx5h8jhzvvnzwcx9f6sqp3x1",
      "name_label": "PUMP_RUNNING",
      "identifier": "PUMP_RUNNING",
      "type": "Actual",
      "datatype": "Boolean",
      "unit": null,
      "description": null,
      "pre_save_script": null,
      "validation_script": null,
      "created_at": "2026-07-10T08:10:48.768472Z",
      "updated_at": "2026-07-10T08:10:48.768472Z",
      "decimal_precision": 5,
      "widget_color": "#FFFF00",
      "derivation_script": null
    },
    {
      "uuid": "01kx5h8jhts452v0g265zpa279",
      "name_label": "VOLTAGE",
      "identifier": "VOLTAGE",
      "type": "Actual",
      "datatype": "Float/Number",
      "unit": null,
      "description": null,
      "pre_save_script": null,
      "validation_script": null,
      "created_at": "2026-07-10T08:10:48.768001Z",
      "updated_at": "2026-07-10T08:10:48.768001Z",
      "decimal_precision": 5,
      "widget_color": "#FF1493",
      "derivation_script": null
    }
  ],
  "meta": {
    "count": 2,
    "message": "Variables fetched successfully",
    "page": 1,
    "per_page": 20,
    "success": true
  }
}

Response Fields

Field	Description
`uuid`	Unique identifier of the variable.
`name_label`	Display name of the variable.
`identifier`	Unique identifier used to reference the variable.
`type`	Type of the variable (for example, `Actual` or `Derived`).
`datatype`	Data type of the variable (for example, `Boolean`, `Integer`, `Float/Number`, or `String`).
`unit`	Engineering unit configured for the variable.
`description`	Description of the variable.
`pre_save_script`	Script executed before incoming values are stored.
`validation_script`	Script used to validate incoming values before they are accepted.
`decimal_precision`	Number of decimal places used when displaying numeric values.
`widget_color`	Default color associated with the variable in dashboards and widgets.
`derivation_script`	Script used to calculate the value of derived variables.
`created_at`	Timestamp when the variable was created (UTC).
`updated_at`	Timestamp of the most recent update (UTC).

Meta Response

Field	Description
`count`	Total number of variables returned in the current response.
`page`	Current page number.
`per_page`	Maximum number of records returned per page.