列出协作者

列出多维表格高级权限中自定义角色的协作者。

前提条件

要调用协作者相关接口，你需确保多维表格已开启高级权限并设置了自定义角色。你可通过更新多维表格元数据接口开启高级权限，通过新增自定义角色接口设置自定义角色。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/bitable/v1/apps/:app_token/roles/:role_id/members
HTTP Method	GET
接口频率限制	20 次/秒
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	base:collaborator:read 列出协作者 bitable:app 查看、评论、编辑和管理多维表格 bitable:app:readonly 查看、评论和导出多维表格

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token

路径参数

名称	类型	描述
app_token	string	多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同： - 如果多维表格的 URL 以 ==feishu.cn/base== 开头，该多维表格的 app_token 是下图高亮部分： - 如果多维表格的 URL 以 ==feishu.cn/wiki== 开头，你需调用知识库相关获取知识空间节点信息接口获取多维表格的 app_token。当 obj_type 的值为 bitable 时，obj_token 字段的值才是多维表格的 app_token。 了解更多，参考多维表格 app_token 获取方式。 示例值："appbcbWCzen6D8dezhoCH2RpMAh"
role_id	string	多维表格高级权限中自定义角色的唯一标识，以 rol 开头。获取方式：通过列出自定义角色接口获取。 示例值："roljRpwIUt"

查询参数

名称	类型	必填	描述
page_size	int	否	分页大小 示例值：100 数据校验规则： - 最大值：100
page_token	string	否	分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 示例值：eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ items	app.role.member\[\]	协作者列表
└ open_id	string	协作者的 open_id
└ union_id	string	协作者的 union_id
└ user_id	string	协作者的 user_id
└ chat_id	string	协作者为一个群聊，群聊的 chat_id
└ department_id	string	协作者为一个部门，部门的 department_id
└ open_department_id	string	协作者为一个部门，部门的 open_department_id
└ member_name	string	协作者的名称
└ member_en_name	string	协作者的英文名称
└ member_type	string	协作者的类型 可选值有： - user: 用户 - chat: 群组 - department: 部门
└ has_more	boolean	是否还有更多项
└ page_token	string	分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
└ total	int	总数

响应体示例

{
    "msg": "success",
    "data": {
        "items": [
            {
                "member_type": "user",
                "member_name": "张敏",
                "member_en_name": "Min Zhang",
                "open_id": "ou_7dab8a3d3cdcc9da365777c7ad5abcef",
                "union_id": "on_7dab8a3d3cdcc9da365777c7ad5abcef",
                "user_id": "13e4beac"
            },
            {
                "member_type": "chat",
                "member_name": "design-chat",
                "member_en_name": "design-chat",
                "chat_id": "oc_a0553eda9014c201e6969b478895c230"
            },
            {
                "member_type": "department",
                "member_name": "design-center",
                "member_en_name": "design-center",
                "department_id": "h121921",
                "open_department_id": "od-4e6ac4d14bcd5071a37a39de902c7141"
            }
        ],
        "page_token": "eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0",
        "total": 3,
        "has_more": true
    },
    "code": 0
}

错误码

HTTP状态码	错误码	描述	排查建议
200	1254000	WrongRequestJson	请求体错误
200	1254001	WrongRequestBody	请求体错误
200	1254002	Fail	导致报 1254002 错误码的场景较多，请参考以下建议排查： - 如果单次操作的内容变更较大，请尝试在单次操作中减少数据量 - 如果你并发调用了接口，请尝试控制请求间隔，稍后重试 - 如果在知识库（wiki）中创建多维表格，请检查你是否使用了知识库创建知识空间节点接口创建多维表格。在此场景下不能使用创建多维表格接口 - 请检查接口参数是否有误。例如，在分页查询多维表格时，传递了无效的 page_token，或传递了错误的数据表的 table_id - 如果该报错偶尔发生，可能是服务器超时或不稳定，请重试解决
200	1254003	WrongBaseToken	app_token 错误。app_token 是多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同： - 如果多维表格的 URL 以 ==feishu.cn/base== 开头，该多维表格的 app_token 是下图高亮部分： - 如果多维表格的 URL 以 ==feishu.cn/wiki== 开头，你需调用知识库相关获取知识空间节点信息接口获取多维表格的 app_token。当 obj_type 的值为 bitable 时，obj_token 字段的值才是多维表格的 app_token。 了解更多，参考多维表格 app_token 获取方式。
200	1254010	ReqConvError	请求错误
400	1254032	InvalidRoleName	自定义角色名无效
400	1254033	RoleNameDuplicated	自定义角色名重复
400	1254036	Base is copying, please try again later.	复制多维表格为异步操作，该错误码表示当前多维表格仍在复制中，在复制期间无法操作当前多维表格。需要等待复制完成后再操作
200	1254040	BaseTokenNotFound	app_token 不存在。不同形态的多维表格，其 app_token 的获取方式不同： - 如果多维表格的 URL 以 ==feishu.cn/base== 开头，该多维表格的 app_token 是下图高亮部分： - 如果多维表格的 URL 以 ==feishu.cn/wiki== 开头，你需调用知识库相关获取知识空间节点信息接口获取多维表格的 app_token。当 obj_type 的值为 bitable 时，obj_token 字段的值才是多维表格的 app_token。 了解更多，参考多维表格 app_token 获取方式。
404	1254047	RoleIdNotFound	role_id 不存在。role_id 是多维表格高级权限中自定义角色的唯一标识，以 rol 开头。可通过列出自定义角色接口获取。
404	1254048	MemberNotFound	协作者 ID 不存在。请检查： - 查询参数 member_id_type 与 member_id 的类型是否保持一致； - member_id 填写是否正确。不同类型的 ID 获取方式不同： - open_id：参考如何获取不同的用户 ID - union_id：参考如何获取不同的用户 ID - user_id：参考如何获取不同的用户 ID - chat_id：参考群 ID 说明 - department_id：调用前，请确保应用有部门的可见性，参考配置应用可用范围。获取 department_id 方式参考部门资源介绍 - open_department_id：调用前，请确保应用有部门的可见性，参考配置应用可用范围。获取 open_department_id 方式参考部门资源介绍
400	1254110	RoleExceedLimit	自定义角色数量超限，限制 30 条
400	1254111	MemberExceedLimit	自定义角色的协作者数量超限，限制 200 个
400	1254200	Something went wrong. Please contact technical support at https://applink.feishu.cn/client/helpdesk/open?id=6626260912531570952	内部错误，请联系技术支持
200	1254290	TooManyRequest	请求过快，稍后重试
200	1254291	Write conflict	在同一个数据表中，并发调用了读写接口或请求过快，出现冲突。请参考以下建议解决： - 确保没有并发调用多维表格读写相关接口 - 若操作量较大，建议在接口与接口之间增加 0.5 或 1 秒的延迟，也可在报错中增加重试逻辑，确保业务的稳定性 - 对于写接口，可以将接口中的查询参数 ignore_consistency_check 设置为 true，表示在读写操作时，暂时忽略一致性检查，以提高性能
400	1254301	OperationTypeError	多维表格未开启高级权限或不支持开启高级权限
403	1254302	Permission denied.	调用身份缺少多维表格的高级权限。你需给予调用身份数据表的 可管理 权限或多维表格的 可管理 等权限，再重新调用。具体步骤如下所示： - 对用户授予高级权限，你可在 多维表格高级权限设置 中添加用户，为用户开通足够权限；或在多维表格页面右上方 分享 入口为当前用户添加可管理权限。详情参考飞书帮助中心文档使用多维表格高级权限。 - 对应用授予高级权限，你需通过多维表格页面右上方 「...」 -> 「...更多」 ->「添加文档应用」 入口为应用添加可管理权限。 注意： 在 添加文档应用 前，你需确保目标应用至少开通了一个多维表格的 API 权限。否则你将无法在文档应用窗口搜索到目标应用。 - 你也可以在 多维表格高级权限设置 中添加用户或一个包含应用的群组，给予这个群自定义的读写等权限。
200	1255001	InternalError	内部错误，请联系技术支持
200	1255002	RpcError	内部错误，请联系技术支持
200	1255003	MarshalError	序列化错误，请联系技术支持
200	1255004	UmMarshalError	反序列化错误，请联系技术支持
504	1255040	Request timed out, please try again later	请求超时，进行重试