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

# Get Live Outlets

Fetch the latest outlet information for a device. When the device is offline, the last known outlet data is returned with a 503 status.

# 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": {
      "Outlet": {
        "type": "object",
        "properties": {
          "connectionState": {
            "type": "string",
            "description": "\"Connected\" when outlet telemetry is current."
          },
          "outletName": {
            "type": "string",
            "description": "Display name configured for the outlet."
          },
          "customRebootTimeEnabled": {
            "type": "boolean",
            "description": "True when the outlet uses a custom reboot delay."
          },
          "customRebootTime": {
            "type": "integer",
            "format": "int32",
            "description": "Configured reboot delay in seconds."
          },
          "rebootStatus": {
            "type": "string",
            "description": "Current reboot workflow state."
          },
          "currentRms": {
            "type": "number",
            "format": "float",
            "description": "Measured RMS current draw in amps."
          },
          "circuitVoltage": {
            "type": "number",
            "format": "float",
            "description": "Line voltage feeding the outlet."
          },
          "power": {
            "type": "number",
            "format": "float",
            "description": "Real power consumption in watts."
          },
          "referenceValue": {
            "type": "number",
            "format": "float",
            "description": "User-configured reference power value, when set."
          },
          "state": {
            "type": "string",
            "description": "\"ON\" when energized, otherwise \"OFF\"."
          },
          "voltageDetection": {
            "type": "boolean",
            "description": "True when voltage sensing is enabled for the outlet."
          },
          "relayHealth": {
            "type": "string",
            "description": "Health status reported for the outlet relay."
          },
          "pwrOnState": {
            "type": "string",
            "description": "Power-on default state (for example \"ON\", \"OFF\", or \"PREV\")."
          },
          "outletIndex": {
            "type": "integer",
            "format": "int32",
            "description": "Outlet index starting at 1."
          },
          "receptacle": {
            "type": "string",
            "description": "Outlet receptacle type."
          },
          "bankId": {
            "type": "integer",
            "format": "int64",
            "description": "Numeric identifier for the containing bank."
          },
          "enclosureSerialNumber": {
            "type": "integer",
            "format": "int64",
            "description": "Serial number for the owning device."
          },
          "pduLabeledOutletNum": {
            "type": "integer",
            "format": "int32",
            "description": "Human-visible label printed on the PDU."
          },
          "outlet_id": {
            "type": "string",
            "description": "Composite outlet identifier (<index>-<bankId>)."
          },
          "bank_id": {
            "type": "integer",
            "format": "int64",
            "description": "Bank identifier alias matching bankId."
          },
          "pdu_labeled_outlet_num": {
            "type": "integer",
            "format": "int32",
            "description": "Snake case alias for pduLabeledOutletNum."
          },
          "last_known_name": {
            "type": "string",
            "description": "Most recently reported outlet name from the controller."
          },
          "last_known_name_updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp when last_known_name was recorded."
          }
        }
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "tags": [
    {
      "name": "Device Live Telemetry",
      "description": "Real-time telemetry snapshots for device outlets, inlets, banks, sensors, and events."
    }
  ],
  "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/{enclosureSerialNumber}/outlets": {
      "get": {
        "summary": "Get Live Outlets",
        "description": "Fetch the latest outlet information for a device. When the device is offline, the last known outlet data is returned with a 503 status.",
        "operationId": "device-live-outlets",
        "parameters": [
          {
            "name": "enclosureSerialNumber",
            "in": "path",
            "description": "Unique serial number for the device enclosure.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Outlet"
                      }
                    }
                  }
                },
                "examples": {
                  "Result": {
                    "value": {
                      "data": [
                        {
                          "connectionState": "Connected",
                          "outletName": "Outlet 1",
                          "customRebootTimeEnabled": false,
                          "customRebootTime": 5,
                          "rebootStatus": "none",
                          "currentRms": 0,
                          "circuitVoltage": 116,
                          "power": 0,
                          "referenceValue": 0,
                          "state": "ON",
                          "voltageDetection": true,
                          "relayHealth": "OK",
                          "pwrOnState": "ON",
                          "outletIndex": 1,
                          "receptacle": "NEMA 5-20R",
                          "bankId": 2009571,
                          "enclosureSerialNumber": 1509033,
                          "pduLabeledOutletNum": 1,
                          "outlet_id": "1-2009571",
                          "bank_id": 2009571,
                          "pdu_labeled_outlet_num": 1,
                          "last_known_name": "Outlet 1",
                          "last_known_name_updated_at": "2025-04-08T20:45:06.422Z"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "503",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "code": {
                      "type": "string",
                      "example": "DEVICE_OFFLINE"
                    },
                    "message": {
                      "type": "string",
                      "example": "Device is offline. Displaying last known outlet information."
                    },
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false,
        "tags": [
          "Device Live Telemetry"
        ]
      }
    }
  }
}
```