Request Method
Request Parameters
Parameters | Type | Required | Description |
access_token | string | Y | Authentication token |
org_id | string | Y | Organization ID |
account | string | Y | Username (Account, limited to 6-12 English characters or digits) |
nick_name | string | Y | Nickname |
phone | string | Y | Phone Number |
password | string | N | Password (default: a123456) |
mobile_prefix | string | N | Country Code (e.g., China: 86) |
string | N | ||
display_in_org | boolean | N | • true: Yes • false: No Display in Address Book |
main_dept | string | N | Primary Department (one of multiple departments) |
dept_ids | string[] | N | Departments (an employee can belong to multiple departments) |
post_id | string | N | Position ID |
first_work_date | date | N | First Work Date yyyy-MM-dd |
join_date | date | N | Join Date yyyy-MM-dd |
Request Example:
json
Return:
Return Details:
Fields | Type | Desc |
data | User List | |
org | string | Organization Name |
org_id | string | Organization ID |
account_id | string | User ID |
account | string | User Account |
nick_name | string | Nickname |
status | int | "1": Normal, "2": Disabled, "3": Resigned |
is_online | boolean | • false: Offline • true: Online |
mobile_prefix | int | Phone Number Prefix |
phone | string | Phone Number |
string | ||
gender | int | Gender, "1": Male, "2": Female |
avatar | string | User Avatar URL |
reg_time | date | Registration Time yyyy-MM-dd HH:mm:ss |
Error Codes
code | message | Desc |
100040 | Invalid org id | Invalid org id |
100062 | Invalid mobile number | Invalid mobile number |
100063 | email already exist error | email already exist error |
100064 | Invalid email | Invalid email |
100111 | Invalid account | Invalid account |
100140 | Invalid nick name | Invalid nick name |
100141 | Invalid password | Invalid password |
100142 | account already exist error | account already exist error |
100143 | org account already exist error | org account already exist error |
100144 | account dept is null | account dept is null |
More Global Codes | ||