简要描述:

  • 用户列表接口

请求URL:

  • /api/v2/user/list

请求方式:

  • GET

请求头:

请求参数:

字段名 是否必填 参数类型 描述
page false 页码
per_page false 每页的数量
name false 查询条件 根据用户name查询
department_id false 部门id
user_id false 用户id
sort false 排序类型
order false 升序asc还是降序desc
except_user_id false 排除用户的id
dingtalk_userid false 钉钉版本的 钉钉userid
phone false 用户的手机号码

正确时返回:


{
  "code": 0,
  "data": {
    "users": [
      {
        "id": 11506206,
        "email": "",
        "created_at": "2019-02-12T21:35:34.000+08:00",
        "name": "Aimi",
        "organization_id": 49,
        "phone": "15010248762",
        "role_id": 169,
        "workflow_state": "organization_staff",
        "job": "",
        "tel": "",
        "gender": "female",
        "role": "超级管理员",
        "role_json": {
          "id": 169,
          "name": "超级管理员",
          "entity_grant_scope": "organization_own"
        },
        "department_id": 395,
        "department_name": "总经理办公室",
        "avatar_url": "https://e.ikcrm.com/assets/female_uc.jpg",
        "departments_manager": false,
        "is_super_user": true,
        "confirmed_phone_at": "2019-02-21 09:36",
        "pending_report": false,
        "superior_id": 0,
        "superior_name": "",
        "organization_name": "爱客CRM",
        "have_new_feature_on_sales_circle": false,
        "sales_circle_msg_count": 0,
        "assist_departments": [
        ],
        "locked_at": "",
        "enabled_number_hidden_dispose": false,
        "dingtalk_userid": "",
        "uid": 11903931,
        "organization_oid": 11529379,
      }
    ],
    "page": 1,
    "per_page": 15,
    "total_count": 18
  }
}

错误时返回:


{
  "code": 100401,
  "message": "您的登录已经过期,请重新登录!",
  "error": "user_authentication_error"
}

返回参数说明:

参数名 类型 说明
is_super_user boolean 是否超管

备注:

文档更新时间: 2025-04-29 14:18   作者:陈胜海