API - 获取链接分组

侯小猴

发布于 2024-08-09 01:36:03

接口地址

https://api.xiaomark.com/v1/group/get

请求方法

POST

请求参数

参数名	类型	是否必传	描述
apikey	string	是	用户的API密钥

请求POST数据示例

{
    "apikey": "361f534e9897e75af4206ea820365fde"
}

获取链接分组接口_POST数据示例图

返回参数说明

名称	类型	描述
code	integer	返回码
message	string	错误信息
data	object	请求成功返回的数据
data.groups	object数组	用户的链接分组，详见分组信息
data.workspaces	object数组	用户创建或加入的协作空间，详见下文空间信息

分组信息 groups

名称	类型	描述
sid	string	sid
name	string	分组名称
n_links	integer	该分组下的链接数量

空间信息 workspaces

名称	类型	描述
name	string	空间名称
role	string	用户在该空间的角色（创建者为creator，协作者为collaborator）
groups	object数组	该空间下的链接分组，详见分组信息

返回结果示例

{
    "code": 0,
    "data": {
        "groups": [
            {
                "n_links": 2,
                "name": "默认分组",
                "sid": "uu4dv4fb"
            },
            {
                "n_links": 3,
                "name": "分组1",
                "sid": "w7ho5te8"
            }
        ],
        "workspaces": [
            {
                "groups": [
                    {
                        "n_links": 2,
                        "name": "默认分组",
                        "sid": "y8e32c4h"
                    },
                ],
                "name": "我创建的空间",
                "role": "creator"
            },
            {
                "groups": [
                    {
                        "n_links": 2,
                        "name": "默认分组",
                        "sid": "6yif6uej"
                    },
                    {
                        "n_links": 12,
                        "name": "测试分组",
                        "sid": "z6edywtw"
                    },
                ],
                "name": "我加入的空间",
                "role": "collaborator",
            }
        ]
    },
    "message": "请求成功",
}