查询文件夹详情

请求地址

权限

readFolder
确保调用该接口使用的访问令牌开通了 readFolder 权限，详细信息参考鉴权方式。

接口说明

查询文件夹详情。

Authorization

Bearer $Access_Token

用于验证客户端身份的访问令牌。你可以在扣子编程中生成访问令牌，详细信息，参考准备工作。

Content-Type

application/json

请求正文的方式。

folder_id

String

必选

7523161255335***1

文件夹 ID。你可以通过扣子编程页面获取文件夹 ID：
进入指定工作空间，单击项目管理，单击目标文件夹，在 URL 中 folder_id 参数后的数字就是文件夹 ID。例如：https://code.coze.cn/w/74982048832804***/projects?folder_id=75635667770837***，folder_id 为 75635667770837***。

data

Object of FolderSimpleInfo

{“id”:“1234567****”,“name”:“项目文档”,“description”:“存放2023年项目相关文档”,“workspace_id”:“5123945629***”,“creator_user_id”:“24787743932***”,“parent_folder_id”:“1234567890***”}

包含文件夹的详细信息，如文件夹 ID、名称、描述、所属工作空间 ID、创建者用户 UID 和父文件夹 ID。

code

Long

0

调用状态码。0 表示调用成功，其他值表示调用失败，你可以通过 msg 字段判断详细的错误原因。

msg

String

“”

状态信息。API 调用失败时可通过此字段查看详细错误信息。
状态码为 0 时，msg 默认为空。

detail

Object of ResponseDetail

{“logid”:“20241210152726467C48D89D6DB2****”}

包含本次请求的详细日志信息，用于问题排查和技术支持。

id

String

1752316125533542***

文件夹 ID。

name

String

项目文档

文件夹的名称，用于标识和区分不同的文件夹。

description

String

存放2023年项目相关文档

文件夹的描述信息，用于提供关于文件夹的额外说明或备注。

folder_type

String

development

文件夹类型，当前仅支持 development。

workspace_id

String

5123945629***

文件夹所属的工作空间的 Space ID。Space ID 是空间的唯一标识。

creator_user_id

String

24787743932***

创建该文件夹的扣子用户 UID，用于标识文件夹的创建者。

parent_folder_id

String

754268556394029***

当前文件夹的父文件夹 ID，用于标识文件夹的层级关系。如果未返回该字段，则表示当前文件夹为根文件夹。

logid

String

20241210152726467C48D89D6DB2****

本次请求的日志 ID。如果遇到异常报错场景，且反复重试仍然报错，可以根据此 logid 及错误码联系扣子团队获取帮助。详细说明可参考获取帮助和技术支持。