---
updatedAt: 2026-07-20T23:26:36.000Z
agentTools:
  projectIndex: https://synaccess.readme.io/llms.txt
---

# List Device Groups

Return a paginated, searchable list of device groups visible to the authenticated user, including fleet-status summary fields.

# 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": {
      "GroupUser": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "Unique database identifier for the user."
          },
          "user_id": {
            "type": "string",
            "description": "Public user identifier, when available."
          },
          "email_id": {
            "type": "string",
            "description": "Username or email address for the user."
          },
          "is_enterprise_admin": {
            "type": "boolean"
          },
          "has_admin_privileges": {
            "type": "boolean"
          },
          "active_in_enterprise": {
            "type": "boolean"
          }
        }
      },
      "Group": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "Unique identifier for the group.",
            "example": 168
          },
          "role_id": {
            "type": "string",
            "description": "Role assigned to users who have direct access to the group."
          },
          "name": {
            "type": "string",
            "maxLength": 255,
            "description": "User-defined group name.",
            "example": "Lab Bench PDUs"
          },
          "description": {
            "type": "string",
            "description": "User-defined group description.",
            "example": "PDUs installed on the lab benches."
          },
          "groupType": {
            "type": "string",
            "enum": [
              "outlets",
              "devices"
            ],
            "description": "Type of resources contained in the group."
          },
          "outletBatchDelay": {
            "type": [
              "number",
              "null"
            ],
            "minimum": 0,
            "description": "Delay in seconds between batch operations for an outlet group."
          },
          "items": {
            "type": "array",
            "description": "Current member IDs. Device groups contain enclosure serial numbers; outlet groups contain outlet IDs.",
            "items": {
              "type": "string"
            },
            "example": [
              "1502455"
            ]
          },
          "itemsOnline": {
            "type": "integer",
            "description": "Number of group devices currently online."
          },
          "itemsCount": {
            "type": "integer",
            "description": "Total number of group members."
          },
          "itemsOffline": {
            "type": "integer",
            "description": "Number of group devices currently offline."
          },
          "activeAlertCount": {
            "type": [
              "integer",
              "null"
            ],
            "description": "Number of active alerts visible to the authenticated user."
          },
          "users": {
            "type": "array",
            "description": "Users with access to the group. This list is populated for administrators.",
            "items": {
              "$ref": "#/components/schemas/GroupUser"
            }
          },
          "role": {
            "type": "object",
            "description": "Expanded role details when a role is assigned."
          }
        }
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "tags": [
    {
      "name": "Groups",
      "description": "Group inventory and management 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/groups": {
      "get": {
        "summary": "List Device Groups",
        "description": "Return a paginated, searchable list of device groups visible to the authenticated user, including fleet-status summary fields.",
        "operationId": "list-device-groups-v2",
        "parameters": [
          {
            "name": "page",
            "in": "query",
            "description": "Page number (1-based)",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "default": 1
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "Number of groups per page",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "default": 25
            }
          },
          {
            "name": "search",
            "in": "query",
            "description": "Case-insensitive match against group name or description",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sortBy",
            "in": "query",
            "schema": {
              "type": "string",
              "enum": [
                "name",
                "deviceCount",
                "offlineCount",
                "activeAlertCount"
              ],
              "default": "deviceCount"
            }
          },
          {
            "name": "sortDir",
            "in": "query",
            "schema": {
              "type": "string",
              "enum": [
                "asc",
                "desc"
              ],
              "default": "desc"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated device groups",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Group"
                      }
                    },
                    "meta": {
                      "type": "object",
                      "properties": {
                        "currentPage": {
                          "type": "integer"
                        },
                        "limit": {
                          "type": "integer"
                        },
                        "totalCount": {
                          "type": "integer"
                        },
                        "totalPages": {
                          "type": "integer"
                        },
                        "totalDeviceGroups": {
                          "type": "integer"
                        },
                        "searchMatchedCount": {
                          "type": "integer"
                        },
                        "sortBy": {
                          "type": "string"
                        },
                        "sortDir": {
                          "type": "string"
                        },
                        "summary": {
                          "type": "object",
                          "properties": {
                            "groupCount": {
                              "type": "integer"
                            },
                            "totalDevices": {
                              "type": "integer"
                            },
                            "onlineDevices": {
                              "type": "integer"
                            },
                            "offlineDevices": {
                              "type": "integer"
                            },
                            "assignedUsers": {
                              "type": "integer"
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false,
        "tags": [
          "Groups"
        ]
      }
    }
  }
}
```