---
updatedAt: 2026-04-29T00:49:36.000Z
agentTools:
  projectIndex: https://synaccess.readme.io/llms.txt
---

# List All Devices

Access a list of provisioned SynLink devices. Must include API key. Returns devices that are associated with the user linked to the API key.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Cloud.Synaccess",
    "version": "1.3"
  },
  "servers": [
    {
      "url": "https://cloud.synaccess.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "name": "authorization",
        "in": "header",
        "x-default": "Bearer"
      }
    },
    "schemas": {
      "DeviceSummary": {
        "type": "object",
        "properties": {
          "deviceName": {
            "type": "string",
            "description": "User-assigned name for the PDU."
          },
          "connectionState": {
            "type": "string",
            "description": "Current cloud connectivity state."
          },
          "numBanks": {
            "type": "integer",
            "format": "int32",
            "description": "Number of outlet banks available on the device."
          },
          "numOutlets": {
            "type": "integer",
            "format": "int32",
            "description": "Total number of controllable outlets."
          },
          "numDryContactRelays": {
            "type": "integer",
            "format": "int32",
            "description": "Number of dry contact relays included with the controller."
          },
          "numInlets": {
            "type": "integer",
            "format": "int32",
            "description": "Number of power inlets exposed by the chassis."
          },
          "inletPlug": {
            "type": "string",
            "description": "Physical plug/receptacle type for the inlet."
          },
          "outletPwrMeasurementsSupported": {
            "type": "boolean",
            "description": "True when the device reports per-outlet power telemetry."
          },
          "inletCurrentSupported": {
            "type": "boolean",
            "description": "True when aggregate inlet current telemetry is supported."
          },
          "outletSwitchingSupported": {
            "type": "boolean",
            "description": "True when outlets can be remotely switched."
          },
          "inletEnergySupported": {
            "type": "boolean",
            "description": "True when cumulative inlet energy readings are available."
          },
          "enclosureSerialNumber": {
            "type": "integer",
            "format": "int64",
            "description": "Unique enclosure serial number assigned to the PDU."
          },
          "modelNumber": {
            "type": "string",
            "description": "Commercial model identifier."
          },
          "inletConfig": {
            "type": "string",
            "description": "Inlet wiring configuration (for example \"standard\")."
          },
          "formFactor": {
            "type": "string",
            "description": "Mechanical chassis form factor (for example \"1U\" or \"Compact\")."
          },
          "controllerSerialNumber": {
            "type": "integer",
            "format": "int64",
            "nullable": true,
            "description": "Serial number of the SynLink controller module. May be null for legacy hardware."
          },
          "controllerFirmwareVersion": {
            "type": "string",
            "description": "Currently running controller firmware version string."
          },
          "controllerHardwareVersion": {
            "type": "string",
            "description": "Hardware revision for the controller module."
          },
          "phase": {
            "type": "string",
            "description": "Power phase configuration."
          },
          "circuitBreakerProtection": {
            "type": "boolean",
            "description": "True when the device includes integrated circuit breaker protection."
          },
          "lastFwUpdateStatus": {
            "type": "string",
            "description": "Last reported firmware update status combined with epoch timestamp."
          },
          "update_pending_firmware": {
            "type": "string",
            "nullable": true,
            "description": "Version string queued for installation, when applicable."
          },
          "update_initiated_time": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "description": "Timestamp when the pending firmware update was initiated."
          },
          "controllerFirmwareVersionUpdatedAt": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "description": "Timestamp of the most recent controller firmware version change."
          },
          "lastHeard": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "description": "Timestamp of the last heartbeat received from the controller."
          }
        }
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "tags": [
    {
      "name": "Device Inventory",
      "description": "Inventory, detail, and summary endpoints for SynLink devices."
    }
  ],
  "x-tagGroups": [
    {
      "name": "Devices",
      "tags": [
        "Device Inventory",
        "Device Live Telemetry",
        "Device Logs",
        "Configuration",
        "Firmware"
      ]
    },
    {
      "name": "Power Control",
      "tags": [
        "Outlets",
        "PDU Outlet Groups",
        "Inlets",
        "Banks",
        "Sensors"
      ]
    },
    {
      "name": "Automation",
      "tags": [
        "Events",
        "Actions"
      ]
    },
    {
      "name": "Organization",
      "tags": [
        "Groups"
      ]
    }
  ],
  "paths": {
    "/v2/devices": {
      "get": {
        "summary": "List All Devices",
        "description": "Access a list of provisioned SynLink devices. Must include API key. Returns devices that are associated with the user linked to the API key.",
        "operationId": "devices",
        "parameters": [
          {
            "name": "page",
            "in": "query",
            "description": "Page number (1-based)",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 1
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "Results per page (max recommended = 100)",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 20
            }
          },
          {
            "name": "search",
            "in": "query",
            "description": "Case-insensitive match on device name, model number, or enclosure serial number",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "connectionState",
            "in": "query",
            "description": "\"connected\" or \"disconnected\" to filter by current connection status.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sortBy",
            "in": "query",
            "description": "\"devicename\" or \"enclosureserialnumber\". If omitted, results are ordered Connected → Disconnected.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sortDir",
            "in": "query",
            "description": "\"asc\" or \"desc\". Ignored when sortBy is not provided.",
            "schema": {
              "type": "string",
              "default": "asc"
            }
          },
          {
            "name": "groupId",
            "in": "query",
            "description": "Return only devices that are members of the specified group ID.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": [
                      {
                        "deviceName": "SynLink PDU",
                        "connectionState": "Connected",
                        "numBanks": 1,
                        "numOutlets": 8,
                        "numDryContactRelays": 0,
                        "numInlets": 1,
                        "inletPlug": "IEC-320 C20R",
                        "outletPwrMeasurementsSupported": false,
                        "inletCurrentSupported": false,
                        "outletSwitchingSupported": false,
                        "inletEnergySupported": true,
                        "enclosureSerialNumber": 1509032,
                        "modelNumber": "1001DIE-01",
                        "inletConfig": "standard",
                        "formFactor": "1U",
                        "controllerSerialNumber": 1293822232,
                        "controllerFirmwareVersion": "2.5.102",
                        "controllerHardwareVersion": "SP000005 1.17.0",
                        "phase": "Single Phase",
                        "circuitBreakerProtection": false,
                        "lastFwUpdateStatus": "Success-1755287399",
                        "update_pending_firmware": null,
                        "update_initiated_time": null,
                        "controllerFirmwareVersionUpdatedAt": "2025-08-15T19:55:17.537Z",
                        "lastHeard": "2025-09-24T18:54:54.533Z"
                      },
                      {
                        "deviceName": "SynLink PDU",
                        "connectionState": "Connected",
                        "numBanks": 1,
                        "numOutlets": 4,
                        "numDryContactRelays": 2,
                        "numInlets": 1,
                        "inletPlug": "IEC-320 C20R",
                        "outletPwrMeasurementsSupported": true,
                        "inletCurrentSupported": false,
                        "outletSwitchingSupported": true,
                        "inletEnergySupported": true,
                        "enclosureSerialNumber": 1509033,
                        "modelNumber": "1001CIE-01-SP1",
                        "inletConfig": "standard",
                        "formFactor": "Compact",
                        "controllerSerialNumber": 1462577936,
                        "controllerFirmwareVersion": "2.5.102",
                        "controllerHardwareVersion": "SP000005 1.17.0",
                        "phase": "Single Phase",
                        "circuitBreakerProtection": false,
                        "lastFwUpdateStatus": "Success-1755287485",
                        "update_pending_firmware": null,
                        "update_initiated_time": null,
                        "controllerFirmwareVersionUpdatedAt": "2025-08-15T19:56:34.262Z",
                        "lastHeard": "2025-09-24T18:54:55.239Z"
                      }
                    ]
                  }
                },
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/DeviceSummary"
                  }
                }
              }
            }
          },
          "401": {
            "description": "401",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"error\": \"INVALID_TOKEN\",\n  \"message\": \"Token is invalid\",\n  \"statusCode\": 401\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "example": "INVALID_TOKEN"
                    },
                    "message": {
                      "type": "string",
                      "example": "Token is invalid"
                    },
                    "statusCode": {
                      "type": "integer",
                      "example": 401,
                      "default": 0
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false,
        "tags": [
          "Device Inventory"
        ]
      }
    }
  }
}
```