获取审计协议签署人员信息

GET

/v1.0/exclusive/audits/users

**
接口调用量说明**当前接口为钉钉专属版专用接口，你可升级钉钉专属版(Open API调用量500万次/月)获取接口调用权限以及扩容调用次数。

本接口用于获取审计应用内已签署和未签署人员的信息，包括人员的姓名，userId，手机号，部门等信息。

例如，审计应用内查看的条款签署情况为

已签署：3人。

未签署：79人。

调用本接口可以获取到已签署和未签署员工的信息，如下图所示。

权限

要调用此API，需要以下权限之一。

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	专属钉钉审计读权限	API Explorer
第三方企业应用	支持	专属钉钉审计读权限	API Explorer
第三方个人应用	暂不支持	专属钉钉审计读权限	暂不支持

错误码

HttpCode	错误码	错误信息	说明
400	param.missing	参数不能为空	参数不能为空
500	system.busy	系统繁忙，请稍后再试	系统繁忙

请求参数

Query 参数

Header 参数

返回响应

🟢200成功

application/json

Body

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.dingtalk.com/v1.0/exclusive/audits/users?pageNumber=Long&signStatus=Long&pageSize=Long' \
--header 'x-acs-dingtalk-access-token;'

响应示例

{
    "auditSignedDetailDTOList": [
        {
            "name": "string",
            "staffId": "string",
            "title": "string",
            "phone": "string",
            "email": "string",
            "deptName": "string",
            "roles": "string"
        }
    ],
    "currentPage": 0,
    "pageSize": 0,
    "total": 0
}

修改于 2024-01-18 05:44:37

权限申请

获取审计协议签署人员信息

权限#

错误码#

请求参数

返回响应

权限

错误码