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

# List All Outlets

Returns a list of outlets from all Synaccess CMP connected PDUs

# 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"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "tags": [
    {
      "name": "Outlets",
      "description": "Outlet listing and control endpoints."
    }
  ],
  "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/outlets": {
      "get": {
        "summary": "List All Outlets",
        "description": "Returns a list of outlets from all Synaccess CMP connected PDUs",
        "operationId": "list-all-outlets",
        "parameters": [
          {
            "name": "enclosure_serial_number",
            "in": "query",
            "description": "Unique serial number for a single device. You may provide multiple enclosure serial numbers separated with commas",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Page number (1-based)",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 1
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "Results per page",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 50
            }
          },
          {
            "name": "search",
            "in": "query",
            "description": "Case-insensitive match on outlet name or device serial number.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "connectionState",
            "in": "query",
            "description": "\"connected\" or \"disconnected\" to filter by current link status.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sortBy",
            "in": "query",
            "description": "Only value supported now: \"enclosureserialnumber\".",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sortDir",
            "in": "query",
            "description": "\"asc\" or \"desc\" (only respected when sortBy present).",
            "schema": {
              "type": "string",
              "default": "asc"
            }
          },
          {
            "name": "groupId",
            "in": "query",
            "description": "Return outlets that belong to devices in the specified group ID.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n\t\"data\": [{\n\t\t\t\"id\": \"1-286331153\",\n\t\t\t\"outletName\": \"Outlet 1\",\n\t\t\t\"pwrOnState\": \"PREV\",\n\t\t\t\"outletIndex\": 1,\n\t\t\t\"receptacle\": \"IEC 60320 C19\",\n\t\t\t\"currentRms\": 1.1,\n\t\t\t\"state\": \"ON\",\n\t\t\t\"bankId\": \"286331153\",\n\t\t\t\"customRebootTimeEnabled\": false,\n\t\t\t\"customRebootTime\": 12,\n\t\t\t\"rebootStatus\": \"none\",\n\t\t\t\"voltageDetection\": true,\n\t\t\t\"relayHealth\": \"OK\",\n\t\t\t\"timestamp\": 1656699228132,\n\t\t\t\"connectionState\": \"Connected\",\n\t\t\t\"enclosureSerialNumber\": 1740824,\n    \t\"pduLabeledOutletNum\" : 1\n\t\t},\n\t\t{\n\t\t\t\"id\": \"2-286331153\",\n\t\t\t\"outletName\": \"Outlet 2\",\n\t\t\t\"pwrOnState\": \"PREV\",\n\t\t\t\"outletIndex\": 2,\n\t\t\t\"receptacle\": \"IEC 60320 C13\",\n\t\t\t\"currentRms\": 2.1,\n\t\t\t\"state\": \"ON\",\n\t\t\t\"bankId\": \"286331153\",\n\t\t\t\"customRebootTimeEnabled\": false,\n\t\t\t\"customRebootTime\": 12,\n\t\t\t\"rebootStatus\": \"none\",\n\t\t\t\"voltageDetection\": true,\n\t\t\t\"relayHealth\": \"OK\",\n\t\t\t\"timestamp\": 1656699228132,\n\t\t\t\"connectionState\": \"Connected\",\n\t\t\t\"enclosureSerialNumber\": 1740824,\n    \t\"pduLabeledOutletNum\" : 2\n\t\t},\n\t\t{\n\t\t\t\"id\": \"3-286331153\",\n\t\t\t\"outletName\": \"Outlet 2\",\n\t\t\t\"pwrOnState\": \"PREV\",\n\t\t\t\"outletIndex\": 2,\n\t\t\t\"receptacle\": \"IEC 60320 C13\",\n\t\t\t\"currentRms\": 0.4,\n\t\t\t\"state\": \"ON\",\n\t\t\t\"bankId\": \"286331153\",\n\t\t\t\"customRebootTimeEnabled\": false,\n\t\t\t\"customRebootTime\": 12,\n\t\t\t\"rebootStatus\": \"none\",\n\t\t\t\"voltageDetection\": true,\n\t\t\t\"relayHealth\": \"OK\",\n\t\t\t\"timestamp\": 1656699228132,\n\t\t\t\"connectionState\": \"Connected\",\n\t\t\t\"enclosureSerialNumber\": 1740824,\n    \t\"pduLabeledOutletNum\" : 3\n\t\t},\n\t\t{\n\t\t\t\"id\": \"4-286331153\",\n\t\t\t\"outletName\": \"Outlet 4\",\n\t\t\t\"pwrOnState\": \"PREV\",\n\t\t\t\"outletIndex\": 2,\n\t\t\t\"receptacle\": \"IEC 60320 C13\",\n\t\t\t\"currentRms\": 1.1,\n\t\t\t\"state\": \"ON\",\n\t\t\t\"bankId\": \"286331153\",\n\t\t\t\"customRebootTimeEnabled\": false,\n\t\t\t\"customRebootTime\": 12,\n\t\t\t\"rebootStatus\": \"none\",\n\t\t\t\"voltageDetection\": true,\n\t\t\t\"relayHealth\": \"OK\",\n\t\t\t\"timestamp\": 1656699228132,\n\t\t\t\"connectionState\": \"Connected\",\n\t\t\t\"enclosureSerialNumber\": 1740824,\n    \t\"pduLabeledOutletNum\" : 4\n\t\t}\n\t]\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "example": "1-286331153"
                          },
                          "outletName": {
                            "type": "string",
                            "example": "Outlet 1"
                          },
                          "pwrOnState": {
                            "type": "string",
                            "example": "PREV"
                          },
                          "outletIndex": {
                            "type": "integer",
                            "example": 1,
                            "default": 0
                          },
                          "receptacle": {
                            "type": "string",
                            "example": "IEC 60320 C19"
                          },
                          "currentRms": {
                            "type": "number",
                            "example": 1.1,
                            "default": 0
                          },
                          "state": {
                            "type": "string",
                            "example": "ON"
                          },
                          "bankId": {
                            "type": "string",
                            "example": "286331153"
                          },
                          "customRebootTimeEnabled": {
                            "type": "boolean",
                            "example": false,
                            "default": true
                          },
                          "customRebootTime": {
                            "type": "integer",
                            "example": 12,
                            "default": 0
                          },
                          "rebootStatus": {
                            "type": "string",
                            "example": "none"
                          },
                          "voltageDetection": {
                            "type": "boolean",
                            "example": true,
                            "default": true
                          },
                          "relayHealth": {
                            "type": "string",
                            "example": "OK"
                          },
                          "timestamp": {
                            "type": "integer",
                            "example": 1656699228132,
                            "default": 0
                          },
                          "connectionState": {
                            "type": "string",
                            "example": "Connected"
                          },
                          "enclosureSerialNumber": {
                            "type": "integer",
                            "example": 1740824,
                            "default": 0
                          },
                          "pduLabeledOutletNum": {
                            "type": "integer",
                            "example": 1,
                            "default": 0
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false,
        "tags": [
          "Outlets"
        ]
      }
    }
  }
}
```