根据指定条件获取企业成员信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求语法
GET /organization/{organizationId}/members
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| organizationId | string | 是 | 企业标识，也称企业 id | 66c0c9fffeb86b450c199fcd |
| organizationMemberName | string | 否 | 企业成员名 | 名字1 |
| provider | string | 否 | 第三方系统（若是钉钉同步，则是 Dingtalk）， 与 externUid 参数成对使用，只传其中一个，不生效。 | Dingtalk |
| externUid | string | 否 | 第三方系统的用户 id：若是钉钉同步，则是钉钉的员工 User ID；与 provider 参数成对使用，只传其中一个，不生效。 | 1236666 |
| state | string | 否 | 选项：正常（normal），已停用（blocked），已删除（deleted），只能指定一种；若不指定，默认返回正常（normal）状态的成员。 | normal |
| nextToken | string | 否 | 分页中的起始序列，值为上一页请求返回的 nextToken 值。 | "" |
| maxResults | long | 否 | 最大返回数量，0-50，默认值 20 | 20 |
| joinTimeFrom | long | 否 | 加入云效企业时间，单位为毫秒时间戳 | 1631845101798 |
| joinTimeTo | long | 否 | 加入云效企业时间，单位为毫秒时间戳 | 1631845101798 |
| containsExternInfo | boolean | 否 | 返回信息中是否包含第三方信息，默认不包含。 |
返回参数
示例
正常返回示例
JSON格式
{
"requestId": "FC93CE1A-8D7A-13A9-8306-7465DE2E5C0F",
"errorMessage": "error info",
"success": true,
"errorCode": "null",
"nextToken": "\"\"",
"totalCount": 15,
"members": [
{
"accountId": "123456677888",
"birthday": 1631845101798,
"deptLists": [
"测试部门"
],
"email": "123@mail.com",
"hiredDate": 1631845101798,
"identities": {
"externUid": "1236666",
"provider": "Dingtalk"
},
"joinTime": 1631845101798,
"lastVisitTime": 1631845101798,
"mobile": "1390000****",
"organizationMemberName": "名字1",
"organizationRoleName": "管理员",
"organizationRoleId": "8fc0c9ff039711dd64acd000",
"state": "normal",
"jobNumber": "373***"
}
]
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidUser.UserNotInCurrentOrganization | The user is not in the organization. | 当前用户不在该企业中 |
| 403 | InvalidParam.NoPermission | No Permission. | - |
| 404 | InvalidOrganization.NotFound | The organization is not found. | 企业不存在，请检查企业ID是否正确 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-02-27 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-04-13 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
| 2021-09-22 | 新增 OpenAPI | 查看变更详情 |