Get all members of the company
| Properties | Values |
|---|---|
| HTTP method | POST |
| Interface path | /nd/api/enterprise/enterprise_members |
| Category | Enterprise API |
Interface description
Interface path: /nd/api/enterprise/enterprise_members
HTTP method: POST
HTTP method: POST
POST request body parameters
Parameter name Comment (description) lang language type, cn Chinese, en English, optional options { departmentId: //Department id, if not filled in, it means all employees of the enterprise roleId: // Role id, if not filled in, there is no role limit "userType": 0, // 0 - internal personnel, 1 - external personnel "keyName": "", // Search keywords: name, mobile phone number, email address, if not filled in, it means all people "startIndex": 0, "pageSize": 20, status: // 0 - all accounts, 1 - deactivated accounts } Optional
Return field description
{"code":0,"success":true,"members":{},"total":xx}
Call instructions
- Before calling, you need to complete Get token or the corresponding login-free authentication, and carry
Authorization: Bearer <access_token>in the request header. - If there are differences in parameters and return fields due to deployment versions, the actual private cloud API documents and joint debugging results should prevail.
- Category: Enterprise API.