Browser Group API
This document shows request examples and return data structures for the browser group API, used to retrieve team members' browser group lists, including pagination parameters and group field descriptions.
Group Local API Documentation
Query Group List
Title
Query Group List
Brief Description
Paginate query for the group list, supporting filtering by group name and owner user.
Request URL
http://127.0.0.1:54345/group/list
Request Method
POST
Header
| Parameter | Required | Example | Description |
|---|---|---|---|
Content-Type | Yes | application/json | Request body format |
X-Cos-Local-Token | Yes | YOUR_LOCAL_TOKEN | Local access token, can be viewed in the client "Settings - Local API" |
Request Body Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
page | No | number | Page number, default 1 |
page_size | No | number | Number per page, default 100, compatible with pageSize |
all | No | boolean/string | When passed true or all, defaults to per page 10000 |
keyword / group_name | No | string | Group name search, compatible with groupName / name |
owner_uid | No | number/string | Owner user UID, compatible with ownerUid |
owner_account | No | string | Owner account, compatible with ownerAccount / account |
Success Response Example
{
"code": 0,
"msg": "success",
"data": {
"list": [
{
"id": 2001,
"group_name": "Test Group",
"parent_id": 0,
"sort_num": 0,
"browserCount": 2
}
],
"total": 1,
"page": 1,
"page_size": 100
}
}
Success Response Parameter Description
| Parameter | Type | Description |
|---|---|---|
code | number | 0 indicates successful request |
msg | string | Return message |
data.list | array | Group list |
data.list[].id | number/string | Group ID |
data.list[].group_name | string | Group name |
data.list[].parent_id | number/string | Parent group |
data.list[].sort_num | number | Sort order |
data.list[].browserCount | number | Number of windows under the group |
data.total | number | Total number |
data.page | number | Current page number |
data.page_size | number | Number per page |
Notes
The interface only listens on localhost 127.0.0.1, please open and log in to the client before calling.
Add Group
Title
Add Group
Brief Description
Create a new browser group.
Request URL
http://127.0.0.1:54345/group/add
Request Method
POST
Header
| Parameter | Required | Example | Description |
|---|---|---|---|
Content-Type | Yes | application/json | Request body format |
X-Cos-Local-Token | Yes | YOUR_LOCAL_TOKEN | Local access token, can be viewed in the client "Settings - Local API" |
Request Body Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
group_name | Yes | string | Group name, compatible with groupName / name |
parent_id | No | number/string | Parent group, default 0, compatible with parentCode / parentId |
sort_num | No | number | Sort order, default 0, compatible with sortNum |
owner_uid | No | number/string | Owner user UID, compatible with ownerUid |
owner_account | No | string | Owner account, compatible with ownerAccount / account |
Success Response Example
{
"code": 0,
"msg": "success",
"data": {
"id": 2001,
"group_name": "Test Group",
"transferredBrowserIds": []
}
}
Success Response Parameter Description
| Parameter | Type | Description |
|---|---|---|
code | number | 0 indicates successful request |
msg | string | Return message |
data.id | number/string | New group ID |
data.group_name / data.groupName | string | Group name |
data.transferredBrowserIds | array | Array of window IDs transferred to this group |
Notes
When adding a top-level group, pass 0 or omit parent_id. Historical field parentCode is still compatible.
Edit Group
Title
Edit Group
Brief Description
Modify the name, parent, sort order, or ownership information of a specified group.
Request URL
http://127.0.0.1:54345/group/edit
Request Method
POST
Header
| Parameter | Required | Example | Description |
|---|---|---|---|
Content-Type | Yes | application/json | Request body format |
X-Cos-Local-Token | Yes | YOUR_LOCAL_TOKEN | Local access token, can be viewed in the client "Settings - Local API" |
Request Body Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
id / group_id | Yes | number/string | Group ID |
group_name | Yes | string | Group name, compatible with groupName / name |
parent_id | No | number/string | Parent group, default 0, compatible with parentCode / parentId |
sort_num | No | number | Sort order, default 0, compatible with sortNum |
owner_uid | No | number/string | Owner user UID, compatible with ownerUid |
owner_account | No | string | Owner account, compatible with ownerAccount / account |
Success Response Example
{
"code": 0,
"msg": "success",
"data": {
"id": 2001,
"group_name": "New Group Name",
"transferredBrowserIds": []
}
}
Success Response Parameter Description
| Parameter | Type | Description |
|---|---|---|
code | number | 0 indicates successful request |
msg | string | Return message |
data.id | number/string | Group ID |
data.group_name / data.groupName | string | Modified group name |
data.transferredBrowserIds | array | Array of window IDs transferred to this group |
Notes
Before editing a group, you can call /group/list or /group/detail to get the group ID.
Delete Group
Title
Delete Group
Brief Description
Delete the specified group by group ID.
Request URL
http://127.0.0.1:54345/group/delete
Request Method
POST
Header
| Parameter | Required | Example | Description |
|---|---|---|---|
Content-Type | Yes | application/json | Request body format |
X-Cos-Local-Token | Yes | YOUR_LOCAL_TOKEN | Local access token, can be viewed in the client "Settings - Local API" |
Request Body Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
id | Yes | number/string | Group ID, can also pass group_id |
Success Response Example
{
"code": 0,
"msg": "success",
"data": {
"id": 2001
}
}
Success Response Parameter Description
| Parameter | Type | Description |
|---|---|---|
code | number | 0 indicates successful request |
msg | string | Return message |
data.id | number/string | Deleted group ID |
Notes
Before deleting a group, confirm the handling method of the windows under the group. The actual result is subject to the current logic of the client and server.
Query Group Detail
Title
Query Group Detail
Brief Description
Query the details of a group by group ID.
Request URL
http://127.0.0.1:54345/group/detail
Request Method
POST
Header
| Parameter | Required | Example | Description |
|---|---|---|---|
Content-Type | Yes | application/json | Request body format |
X-Cos-Local-Token | Yes | YOUR_LOCAL_TOKEN | Local access token, can be viewed in the client "Settings - Local API" |
Request Body Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
id | Yes | number/string | Group ID, can also pass group_id |
Success Response Example
{
"code": 0,
"msg": "success",
"data": {
"id": 2001,
"group_name": "Test Group",
"parent_id": 0,
"sort_num": 0,
"browserCount": 2
}
}
Success Response Parameter Description
| Parameter | Type | Description |
|---|---|---|
code | number | 0 indicates successful request |
msg | string | Return message |
data.id | number/string | Group ID |
data.group_name | string | Group name |
data.parent_id | number/string | Parent group |
data.sort_num | number | Sort order |
data.browserCount | number | Number of windows under the group |
Notes
If the group does not exist, it may return code: 404 and msg: group not found.