v1 API 获取表单协作者

API 使用者，可以通过本接口，获取表单的协作者及其角色

功能	免费版	专业版/专业增强版	企业基础版	企业协作版	企业高级版
获取表单协作者	✔️	✔️	✔️	✔️	✔️

认证方式

V1 Bearer 认证方式

headers 设置

需要在请求中设置如下 headers

• Content-Type: application/json
• Accept: application/json
• Authorization: Bearer YOUR_ACCESS_TOKEN

接口说明

• 返回结果包含直接共享给用户的角色，也包含从文件夹继承的角色。
• 同一个用户既被直接共享、又通过文件夹被共享时，只返回一条记录，角色取距离最近的那一个（直接共享优先于文件夹继承）。
• 表单创建者也在列表中，角色为「表单管理员」。
• 只要能访问该表单即可调用，不需要管理权限。

接口描述

Request

GET https://jinshuju.net/api/v1/forms/FORM_TOKEN/cooperators

参数名称	是否必须	类型	说明
FORM_TOKEN	是	String	表单 Token（URL 路径参数）

Response

{
    "count": 2,
    "data": [
        {
            "user_id": "6a054618200e25a4c1a10b1b",
            "name": "张三",
            "role": "表单管理员"
        },
        {
            "user_id": "6a054618200e25a4c1a10b2c",
            "name": "李四",
            "role": "数据查看者"
        }
    ]
}

参数名称	是否必须	类型	说明
count	是	Number	本次返回的协作者数量
data	是	Array	协作者数组
data[].user_id	是	String	用户 id
data[].name	是	String	用户展示名
data[].role	否	String	该用户在此表单上的角色名称，例如「表单管理员」「数据维护者」「数据查看者」。角色记录异常时可能为 null

状态码

状态码	说明
200	获取成功
401	未认证
402	当前套餐不支持 V1 API
404	表单不存在或无权访问

示例代码

HTTP

GET https://jinshuju.net/api/v1/forms/$FORM_TOKEN/cooperators

Content-Type: application/json
Accept: application/json
Authorization: Bearer YOUR_ACCESS_TOKEN

Python

import requests

access_token = 'YOUR_ACCESS_TOKEN'
form_token = 'YOUR_FORM_TOKEN'

response = requests.get(
    f'https://jinshuju.net/api/v1/forms/{form_token}/cooperators',
    headers={'Authorization': f'Bearer {access_token}'}
)

print(response.text)