Window Groups

List, create, rename or reorder, and delete the window groups of the current team. Groups are a team-wide, single-level folder structure; windows are placed into a group with Move windows to group.

The ungrouped entry is synthesized by the server: its id is always 0, it is always listed first, and it cannot be renamed or deleted. Deleting a user-created group does not delete its windows; they all become ungrouped.

Search this page

Showing 4 of 4 endpoints

GET/group/list

List window groups

Queries all window groups of the current team and the number of windows in each, without pagination.

AuthBearer API Key

Request parameters

None

Notes

• "未分组" (ungrouped) is a fixed item synthesized by the server; its id is always 0 and it cannot be renamed or deleted.
• screenCount is counted by the server in real time from current window membership.

Response fields

Field	Type	Description
data	object[]	Group list; the first item is always the "未分组" (ungrouped) entry, the rest are in ascending seq order
data[].id	number	Group ID; 0 means ungrouped
data[].teamId	number	Team ID the group belongs to
data[].name	string	Group name
data[].seq	number	Sort order, always 0 for ungrouped
data[].screenCount	number	Number of windows in the group
data[].createdAt	string	Creation time
data[].updatedAt	string	Update time

Response example

{
  "code": 0,
  "msg": "成功",
  "data": [
    {
      "id": 0,
      "teamId": 2001,
      "name": "未分组",
      "seq": 0,
      "screenCount": 4,
      "createdAt": "2026-06-01 12:30:00",
      "updatedAt": "2026-06-01 12:30:00"
    },
    {
      "id": 5001,
      "teamId": 2001,
      "name": "社媒运营",
      "seq": 1,
      "screenCount": 12,
      "createdAt": "2026-05-20 09:15:00",
      "updatedAt": "2026-05-20 09:15:00"
    }
  ]
}

POST/group/create

Create window group

Creates a window group in the current team.

AuthBearer API Key

Request parameters

Field	Type	Required	Description
name	string	Required	Group name, must be unique within the team. Missing returns a parameter error
seq	number	Optional	Sort order; when missing, the server appends it after the current last position

Notes

• If a group name duplicates another group in the same team, the whole batch is rejected with a business error.

Response fields

Field	Type	Description
data	object[]	Group set written this time
data[].id	number	ID of the new group
data[].teamId	number	Team ID the group belongs to
data[].name	string	Group name
data[].seq	number	Sort order
data[].createdAt	string	Creation time
data[].updatedAt	string	Update time

Response example

{
  "code": 0,
  "msg": "成功",
  "data": [
    {
      "id": 5002,
      "teamId": 2001,
      "name": "电商店铺",
      "seq": 2,
      "createdAt": "2026-06-10 14:20:00",
      "updatedAt": "2026-06-10 14:20:00"
    }
  ]
}

POST/group/modify

Rename or reorder window group

Updates a group's name or sort order by group ID.

AuthBearer API Key

Request parameters

Field	Type	Required	Description
id	string | number	Required	Group ID. Returns a parameter error if omitted
name	string	Optional	New group name
seq	number	Optional	New sort order

Notes

• Returns a permission error if the group does not belong to the current team; the whole batch is rejected if the name duplicates another group in the same team.
• The ungrouped group (id=0) is synthesized by the server and cannot be renamed or reordered.
• Legacy alias: id may also be passed as groupId.

Response fields

Field	Type	Description
data	object[]	Group set written this time
data[].id	number	Group ID
data[].teamId	number	Team ID the group belongs to
data[].name	string	Group name
data[].seq	number	Sort order
data[].updatedAt	string	Update time

Response example

{
  "code": 0,
  "msg": "成功",
  "data": [
    {
      "id": 5002,
      "teamId": 2001,
      "name": "电商店铺-北美",
      "seq": 2,
      "updatedAt": "2026-06-11 09:05:00"
    }
  ]
}

POST/group/delete

Delete window group

Deletes a user-created window group; all windows in it become ungrouped.

AuthBearer API Key

Request parameters

Field	Type	Required	Description
id	string | number	Required	Group ID, must be a positive integer. Returns a parameter error if omitted

Notes

• Windows in the group are not deleted; they only become ungrouped.
• The ungrouped group (id=0) cannot be deleted; returns a permission error if the group does not belong to the current team.
• Legacy alias: id may also be passed as groupId.

Response fields

Field	Type	Description
data	null	No response data; success is indicated by code=0

Response example

{
  "code": 0,
  "msg": "成功",
  "data": null
}