流程实例与待办
获取用户流程待办列表
根据鉴权方式查看“获取用户流程待办列表”对应的真实 API 地址、参数与响应。
鉴权方式
个人访问令牌（PAT）由用户自行创建，用于以个人身份调用 API。
版本
请求地址
Header 参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
Authorization | string | 是 | Bearer {{access_token}} |
Query 参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
type | string | 否 | 待办类型。 approve 审批，fill 填写，cc 抄送，start 发起，completed 已完成。不传默认返回 待处理 包含(待填写和待审批) 可选值： "approve""fill""cc""start""completed" |
keyword | string | 否 | 关键字，匹配标题、发起人、编号等。 |
processId | string | 否 | 流程 ID。 |
appId | string | 否 | 应用 ID。 |
pageIndex | integer | 否 | 页码，从 1 开始。默认 1。 |
pageSize | integer | 否 | 每页数量。默认 20，最大建议 100。 |
响应参数
200流程待办列表。| 名称 | 类型 | 描述 |
|---|---|---|
success | boolean | 是否成功。 true 表示成功，false 表示失败。 |
error_code | string | 响应码。 0 表示成功。 |
error_msg | string | 响应说明。成功时通常为 ok。 |
data | object[] | — |
data.id | string | 流程实例 ID。 |
data.title | string | 标题。 |
data.status | string | 审批实例状态：
可选值： "running""completed""terminated""failed" |
data.flowNodeType | string | 流程角色类型/节点类型语义化值。真实列表响应常见小写值： approve 审批，fill 填写，cc 抄送，start 发起。兼容历史/内部语义值： Task 填写，UserTask 审批，SendTask 抄送，Approval 审批流，StartEvent 发起节点。可选值： "start""fill""approve""cc""action""branch""gateway""StartEvent""Gateway""Flow""Task""UserTask""SendTask""ServiceTask""Find""Webhook""Formula""Message""Email""TimerEvent""Multiple""Code""Link""SubProcess""Push""Print""TemplateMessage""PBC""Json""Api""Parameter""ApiPackage""ApiPackageApi""Approval""Send""Screenshot""Cycle""Return""Aigc""Plugin""AiAgent""Knowledge""System""AiTool""SystemSingle""SystemMultiple""ChatbotConfig" |
data.entityName | string | 工作表记录名。 |
data.workId | string | 工作 ID。 |
data.createDate | string | 创建时间，格式通常为 YYYY-MM-DD HH:mm:ss。 |
data.completeDate | string | null | 完成时间。 |
data.revokeDate | string | null | 撤回时间。 |
data.app | object | 应用信息。 |
data.app.id | string | 应用 ID。 |
data.app.name | string | 应用名称。 |
data.app.describe | string | null | 应用描述。 |
data.app.icon | string | null | 图标标识。 |
data.app.iconColor | string | null | 图标颜色。 |
data.app.iconUrl | string | null | 图标地址。 |
data.process | object | 流程信息。 |
data.process.id | string | 流程 ID。 |
data.process.name | string | 流程名称。 |
data.process.count | integer | 流程待处理数量。 |
data.process.parentId | string | 编辑版 ID。 |
data.controls | object[] | 表单控件展示值列表。 |
data.controls.controlId | string | 控件 ID。 |
data.controls.controlName | string | 控件名称。 |
data.controls.value | null | 控件值。不同控件类型返回的值格式不同，可能是字符串、数字、数组或对象。 |
data.createAccount | object | 用户信息。 |
data.createAccount.accountId | string | 账号 ID。 |
data.createAccount.avatar | string | null | 头像地址。 |
data.createAccount.fullName | string | 账号名称。 |
data.createAccount.fullname | string | 兼容字段，账号名称。 |
data.createAccount.isOwner | boolean | null | 是否拥有者。 |
data.createAccount.status | integer | null | 用户状态，具体值由服务端定义。 |
data.currentWorkFlowNodes | array | null | 当前正在处理的流程节点列表。 |
data.flowNode | object | 流程节点信息。 |
data.flowNode.id | string | 节点 ID。 |
data.flowNode.name | string | 节点名称。 |
data.flowNode.type | string | 流程角色类型/节点类型语义化值。真实列表响应常见小写值： approve 审批，fill 填写，cc 抄送，start 发起。兼容历史/内部语义值： Task 填写，UserTask 审批，SendTask 抄送，Approval 审批流，StartEvent 发起节点。可选值： "start""fill""approve""cc""action""branch""gateway""StartEvent""Gateway""Flow""Task""UserTask""SendTask""ServiceTask""Find""Webhook""Formula""Message""Email""TimerEvent""Multiple""Code""Link""SubProcess""Push""Print""TemplateMessage""PBC""Json""Api""Parameter""ApiPackage""ApiPackageApi""Approval""Send""Screenshot""Cycle""Return""Aigc""Plugin""AiAgent""Knowledge""System""AiTool""SystemSingle""SystemMultiple""ChatbotConfig" |
data.flowNode.actionId | string | 动作 ID。 |
data.flowNode.alias | string | 别名。 |
data.flowNode.allowUploadAttachment | boolean | 是否允许审批时上传附件。 |
data.flowNode.appId | string | 引用对象 ID。 |
data.flowNode.appType | string | 应用类型语义化值。真实列表响应常见小写值： worksheet 工作表。兼容历史/内部值：WorkSheet 工作表，Approval 审批流，User 人员，Department 部门。可选值： "worksheet""task""email""sms""approval""user""department""Default""WorkSheet""Task""Email""Sms""Repeat""WorkSheetDate""Hooks""WorkSheetButton""WorkSheetApproval""Approval""Formula""Code""Link""Print""SubProcess""PBC""Json""User""Department""TemplateMessage""ExternalUser""OrgRole""WorkSheetSubscribe""AggregationWorksheet""WorkSheetPivot""NoAuth""BasicAuth""OAuth2""OAuth2Code""Parameter""ApiPackage""ApiPackageApi""Calendar""Screenshot""Cycle""Aigc""Plugin""AiAgent""Chatbot""Invoice""Refund""Knowledge""Discussion""System""Custom""ProcessVariable""WorkSheetLog""MdVariable""AiTool""SendTask""Commons" |
data.flowNode.auth | object | 审批节点操作权限配置。 |
data.flowNode.auth.overruleTypeList | string[] | 审批否决需要满足的操作要求。 |
data.flowNode.auth.passTypeList | string[] | 审批通过需要满足的操作要求。 |
data.flowNode.auth.batch | boolean | 是否勾选批量审批。 |
data.flowNode.auth.batchApprove | boolean | 是否允许批量审批。 |
data.flowNode.batchType | string | 批量审批限制规则：
可选值： "requireComment""requireForm""allow""requireSignature" |
data.flowNode.btnMap | object | 自定义按钮名称映射。 |
data.flowNode.callBackType | string | 审批回调策略：
可选值： "none""retry""returnNode" |
data.flowNode.child | boolean | 是否是子流程。 |
data.flowNode.desc | string | 节点说明。 |
data.flowNode.encrypt | boolean | 是否需要登录密码验证。 |
data.flowNode.fastApprove | boolean | 是否允许快速审批。 |
data.flowNode.fieldRequired | boolean | 字段是否必填。 |
data.flowNode.flowIds | string[] | 并行流 ID 列表。 |
data.flowNode.flows | any[] | 并行流信息。 |
data.flowNode.formProperties | any[] | 表单字段属性。 |
data.flowNode.formulaMap | object | 文本拼接字段对应的控件名称和节点名称映射。 |
data.flowNode.nextId | string | 下个节点 ID。 |
data.flowNode.overruleBatchType | string | 批量审批限制规则：
可选值： "requireComment""requireForm""allow""requireSignature" |
data.flowNode.passBatchType | string | 批量审批限制规则：
可选值： "requireComment""requireForm""allow""requireSignature" |
data.flowNode.prveId | string | 上个节点 ID。 |
data.flowNode.resultTypeId | string | 审批结果分支类型： approve 通过分支，reject 否决分支。可选值： "approve""reject" |
data.flowNode.selectNodeId | string | 选中的节点 ID。 |
data.flowNode.selectNodeObj | object | 选中节点对象信息。 |
data.flowNode.selectNodeObj.actionId | string | 方式标识。用于查找节点时，1 搜索，2 关联他表字段。 |
data.flowNode.selectNodeObj.appId | string | 引用对象 ID。 |
data.flowNode.selectNodeObj.appName | string | 引用对象名称。 |
data.flowNode.selectNodeObj.appType | null | — |
data.flowNode.selectNodeObj.appTypeName | string | 应用类型名称。 |
data.flowNode.selectNodeObj.countersign | boolean | 是否是会签组。 |
data.flowNode.selectNodeObj.nodeId | string | 节点 ID。 |
data.flowNode.selectNodeObj.nodeName | string | 节点名称。 |
data.flowNode.selectNodeObj.nodeTypeId | null | — |
data.flowNode.selectNodeObj.subProcessId | string | 执行子流程 ID。 |
data.flowNode.selectNodeObj.triggerField | string | 触发指定控件。 |
data.flowNode.selectNodeObj.triggerFields | string[] | 触发指定控件列表。 |
data.flowNode.selectNodeObj.triggerId | null | — |
data.flowNode.selectNodeObj.type | null | — |
data.flowNode.subProcessId | string | 执行子流程 ID。 |
data.flowNode.triggerField | string | 触发指定控件。 |
data.flowNode.triggerFields | string[] | 触发指定控件列表。 |
data.flowNode.triggerId | string | 触发方式： create 新增触发，update 修改触发。可选值： "create""update" |
data.instanceLog | null | 实例日志。列表接口真实响应为单个对象，部分详情场景可能返回数组。 |
data.instanceLog.cause | null | — |
data.instanceLog.causeAccount | null | — |
data.instanceLog.causeAccount.accountId | string | 账号 ID。 |
data.instanceLog.causeAccount.avatar | string | null | 头像地址。 |
data.instanceLog.causeAccount.fullName | string | 账号名称。 |
data.instanceLog.causeAccount.fullname | string | 兼容字段，账号名称。 |
data.instanceLog.causeAccount.isOwner | boolean | null | 是否拥有者。 |
data.instanceLog.causeAccount.status | integer | null | 用户状态，具体值由服务端定义。 |
data.instanceLog.causeMsg | string | 原因说明。 |
data.instanceLog.createBy | string | 操作人账号 ID。 |
data.instanceLog.createDate | string | 操作时间，格式通常为 YYYY-MM-DD HH:mm:ss。 |
data.instanceLog.flowNodeId | string | 重试的节点 ID。 |
data.instanceLog.msg | string | null | 自定义错误描述。 |
data.instanceLog.nodeId | string | null | 节点 ID。 |
data.instanceLog.nodeName | string | null | 节点名称。 |
data.instanceLog.nodeType | null | — |
data.instanceLog.status | string | 实例日志状态：
可选值： "pending""approved""terminated""failed""rejected""filtered" |
data.workItem | object | 工作项信息。 |
data.workItem.workId | string | 工作 ID。 |
data.workItem.administrator | null | — |
data.workItem.administrator.accountId | string | 账号 ID。 |
data.workItem.administrator.avatar | string | null | 头像地址。 |
data.workItem.administrator.fullName | string | 账号名称。 |
data.workItem.administrator.fullname | string | 兼容字段，账号名称。 |
data.workItem.administrator.isOwner | boolean | null | 是否拥有者。 |
data.workItem.administrator.status | integer | null | 用户状态，具体值由服务端定义。 |
data.workItem.countersign | boolean | null | 是否会签组。 |
data.workItem.countersignComplete | boolean | null | 会签组是否完成。 |
data.workItem.dueTime | string | null | 限时截止时间。 |
data.workItem.executeTime | string | null | 限时执行时间。 |
data.workItem.fileIds | array | null | 附件 ID 列表。 |
data.workItem.files | array | null | 附件列表。 |
data.workItem.logIds | array | null | 行编辑日志 ID 列表。 |
data.workItem.operationTime | string | null | 操作时间。 |
data.workItem.operationType | string | 当前待办操作类型的语义化值。真实列表响应中未操作待办通常返回 default。可选值： "default""submit""sign""delegate""return""cancel""CANCEL_OVERRULE""END_PROCESS""REVOKE""PASS""OVERRULE""FORWARD""SIGN""WORK""SUBMIT""TRANSFER""PRINT""UPDATE""REPLACE""CONTINUE""ADD""RETURN""URGE""TASK_REVOKE""DELEGATIONREVOKE""Before""Email""GET_OPERATION""ADD_OPERATION""RELATION_OPERATION""SOUND" |
data.workItem.type | string | 流程角色类型/节点类型语义化值。真实列表响应常见小写值： approve 审批，fill 填写，cc 抄送，start 发起。兼容历史/内部语义值： Task 填写，UserTask 审批，SendTask 抄送，Approval 审批流，StartEvent 发起节点。可选值： "start""fill""approve""cc""action""branch""gateway""StartEvent""Gateway""Flow""Task""UserTask""SendTask""ServiceTask""Find""Webhook""Formula""Message""Email""TimerEvent""Multiple""Code""Link""SubProcess""Push""Print""TemplateMessage""PBC""Json""Api""Parameter""ApiPackage""ApiPackageApi""Approval""Send""Screenshot""Cycle""Return""Aigc""Plugin""AiAgent""Knowledge""System""AiTool""SystemSingle""SystemMultiple""ChatbotConfig" |
data.workItem.opinion | string | null | 意见。 |
data.workItem.principal | null | — |
data.workItem.principal.accountId | string | 账号 ID。 |
data.workItem.principal.avatar | string | null | 头像地址。 |
data.workItem.principal.fullName | string | 账号名称。 |
data.workItem.principal.fullname | string | 兼容字段，账号名称。 |
data.workItem.principal.isOwner | boolean | null | 是否拥有者。 |
data.workItem.principal.status | integer | null | 用户状态，具体值由服务端定义。 |
data.workItem.receiveTime | string | null | 接收时间。 |
data.workItem.signature | null | — |
data.workItem.signature.authType | string | 审批操作要求：
可选值： "comment""optionalComment""signature""realName""realPerson" |
data.workItem.signature.bucket | integer | 存储桶。 |
data.workItem.signature.key | string | 签名文件 key。 |
data.workItem.signature.server | string | 签名服务地址。 |
data.workItem.signature.type | string | 签名类型： fill 填写，approve 审批，cc 抄送。可选值： "fill""approve""cc" |
data.workItem.updateTime | string | null | 最后一次暂存操作时间。 |
data.workItem.viewTime | string | null | 查看时间。 |
data.workItem.workItemAccount | object | — |
data.workItem.workItemAccount.accountId | string | 账号 ID。 |
data.workItem.workItemAccount.avatar | string | null | 头像地址。 |
data.workItem.workItemAccount.fullName | string | 账号名称。 |
data.workItem.workItemAccount.fullname | string | 兼容字段，账号名称。 |
data.workItem.workItemAccount.isOwner | boolean | null | 是否拥有者。 |
data.workItem.workItemAccount.status | integer | null | 用户状态，具体值由服务端定义。 |
data.workItem.workItemAccount.workItemId | string | 工作项 ID。 |
data.workItemLog | object | 工作项操作日志。 |
data.workItemLog.action | string | 审批操作行为语义化值。 可选值： "submit""transfer""view""approve""reject""reassign""addApprover""removed""preAddSign""postAddSign""modifyRequest""noApprovalNeeded" |
data.workItemLog.actionTarget | string | 动作目标账号 ID。 |
data.workItemLog.actionTargetName | string | 动作目标名称。 |
data.workItemLog.content | string | 意见备注。 |
data.workItemLog.createDate | string | 操作时间。 |
data.fields | object[] | 字段变更列表。 |
data.fields.id | string | 字段 ID。 |
data.fields.name | string | 字段名称。 |
data.fields.fromValue | null | 老值。 |
data.fields.toValue | null | 新值。 |
curl -X GET "https://example.com/v3/app/workflow/instance/list" \ -H "Authorization: Bearer {{access_token}}"{ "data": [ { "id": "f4d6d7d1-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "title": "办公用品采购申请", "status": "running", "flowNodeType": "UserTask", "entityName": "采购单", "workId": "1c68b3c2-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "createDate": "2026-04-20 10:00:00", "completeDate": "2026-04-20 12:00:00", "app": { "id": "app_xxx", "name": "采购管理", "iconColor": "#4E7FFF" }, "process": { "id": "process_xxx", "name": "采购审批", "count": 5 } } ], "success": true, "error_code": "0", "error_msg": "ok"}