---
title: "获取分组列表"
method: POST
path: "/api/v1/things/group/info/index"
tags: ["things/group/info", "thingsGroupInfo"]
---

# 获取分组列表

`POST /api/v1/things/group/info/index`

## Request body

- GroupInfoIndexReq
  - `areaID` string — 区域ID
  - `name` string — 分组名称
  - `page` PageInfo
    - `orders` OrderBy[] — 排序
      - `field` string — 排序的字段名
      - `sort` integer — 排序方式：1 从小到大, 2 从大到小
    - `page` integer — 页码
    - `size` integer — 每页大小
  - `parentID` integer — 父组ID
  - `productID` string — 产品ID
  - `purpose` string — 用途 不填默认为default
  - `tags` Tag[] — 分组tag
    - `key` string, required
    - `value` string, required
  - `withDevices` boolean — true 时返回 list[].devices 设备核心信息

## Response `200`

A successful response.

- object
  - `code` integer
  - `data` GroupInfoIndexResp
    - `list` GroupInfo[], required — 分组信息
      - `areaID` string — 区域ID
      - `children` GroupInfo[]
      - `createdTime` string — 创建时间
      - `desc` string — 分组描述
      - `deviceCount` integer — 设备数量统计
      - `devices` DeviceCore[] — withDevices=true 时返回分组下设备核心信息
        - `deviceName` string, required — 设备名称
        - `productID` string, required — 产品ID
        - `productName` string
      - `files` object — key 是用途, value是文件的路径,
      - `id` integer — 分组ID
      - `idPath` string — 分组ID路径
      - `isLeaf` integer
      - `name` string — 分组名称
      - `parentID` integer — 父组ID
      - `productID` string — 产品ID
      - `productName` string — 产品ID
      - `projectID` string — 项目ID
      - `purpose` string — 用途 不填默认为default
      - `tags` Tag[] — 分组tag
        - `key` string, required
        - `value` string, required
    - `page` integer — 页码
    - `pageSize` integer — 每页大小
    - `total` integer
  - `msg` string

---

[API](https://skmtc.net/unitedrhino/apis/things-api.md) · [All operations](https://skmtc.net/unitedrhino/apis/things-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/unitedrhino/things-api/revisions/f3bdeb916389/schema)
