ATS用户中心
所有文章
系统应用
升级公告
常见问题
公开课
校招专栏
内推和门店
数据平台
亮点功能
热门活动
基础操作视频
API文档
时间字段格式说明(Date)
API开发指南(Guide)
主动推送说明(Webhooks)
公共API
招聘官网API
企业信息API
门店API
组织架构API
职责API
招聘需求 API
候选人API
人才库API
职位API
面试API
Offer API
入职API
内推账户API
猎头API
BI报表API
district code
错误码
获取人事信息
最后更新于 2024/04/03   阅读数 87

HTTP 请求

POST https://api.mokahr.com/api-platform/v1/users/list

请求query参数

字段

必填

类型

描述

next

string

分页参数,如果有更多的数据可供拉取,响应的json中会有一个next字段,下次请求只需要把这个next参数加到query中就可以了。如果响应中没有next字段,表示没有更多的数据了

请求body参数

字段

必填

类型

描述

roleId

integer

角色id

email

string

邮箱

phone

string

电话

number

string

工号

deactivated

integer

是否被禁用
可选值:
0:可用
1:禁用

departmentIdType

string

此次调用中使用的部门ID类型。可选值:
DEPARTMENT_ID(默认值):moka部门id
DEPARTMENT_CODE:三方系统部门id

departmentId

string

用户所属/负责部门id

locale

string

用户语言
可选值:
zh-CN:为中文
en-US:英文
默认为中文

limit

string

分页用的每页条数,默认100,最大500

order

string

拉取数据的排序方式, 排序key为用户创建时间.可选值为:DESC 按照从新到旧的顺序拉取,此为默认值DESC。按照从旧到新的数据拉取。注意:当排序方式为ASC时,无论是否有更多数据,返回body中都会包含next(可用作增量拉取)

返回

返回body的JSON数据如下:

字段

类型

描述

code

number

200:成功
非200代表失败

message

string

提示信息

next

string

分页参数,如果有更多的数据可供拉取,响应的json中会有一个next字段,下次请求只需要把这个next参数加到query中就可以了。如果响应中没有next字段,表示没有更多的数据了

data[].userId

string

用户id

data[].email

string

邮箱

data[].name

string

姓名

data[].phone

string

电话

data[].number

stirng

工号

data[].role

interger

角色
0:内推人
5:前台
10:面试官
20:用人经理
25:高级用人经理
30:HR
40:管理员
50:超管

data[].roleId

interger

自定义角色id

data[].superiorEmail

stirng

上级邮箱

data[].deactivated

stirng

是否被禁用
可选值:
0:可用
1:禁用

data[].isPending

boolean

功能性字段,用作单点登录,没有传空字符串

data[].thirdPartyId

stirng

功能性字段,用作单点登录,没有返回空字符串

data[].locale

string

用户语言
可选值:
zh-CN:为中文
en-US:英文
默认为中文

data[].department

array

用户所属/负责部门

data[].department[].departmentCode

string

三方部门id

data[].department[].departmentId

string

moka部门id

data[].department[].name

string

部门名称

请求样例 (JSON)

curl --location --request POST 'https://api.mokahr.com/api-platform/v1/users/list' \ --header 'Authorization: Basic Mm11UnVBQk******zY6' \ --header 'Content-Type: application/json' \ --data-raw '{ "deactivated": 0, "limit": "20", "order": "asc" }'
1
plaintext

返回示例

{ "code": 200, "message": "success", "data": [ { "userId": 200000188, "email": "test2@sdicfund.com", "name": "马田", "phone": "10065761890", "role": 50, "roleId": 200000145, "deactivated": 0, "thirdPartyId": "", "locale": "zh-CN", "department": [] }, { "userId": 200000307, "email": "1581904186@qq.com", "name": "耿凯3", "phone": "18732837638", "role": 30, "roleId": 200000143, "superiorEmail": "test@sdicfund.com", "deactivated": 0, "thirdPartyId": "", "locale": "zh-CN", "department": [] } ], "next": "200000317" }
1
plaintext
未能解决您的问题?请联系
本篇目录

HTTP 请求

请求query参数

请求body参数

返回

请求样例 (JSON)

返回示例