Chi tiết người dùng
Endpoint: GET /api/v6.1/user
Mô tả:
API dùng để lấy thông tin chi tiết của một user trong hệ thống CRM dựa theo user_username. Thường được sử dụng khi cần xem hồ sơ cá nhân, gán việc, hiển thị thông tin người xử lý, hoặc đồng bộ dữ liệu user.
Yêu cầu
Phương thức: GET
Headers:
X-API-KEY: <api-key-của-bạn>
Query Parameters
Tham số bắt buộc
| Tham số | Kiểu dữ liệu | Mô tả |
|---|---|---|
user_username | string | Tên đăng nhập của user cần lấy thông tin |
Tham số tùy chọn
| Tham số | Mô tả |
|---|---|
fields | Danh sách các trường cần lấy, phân cách bằng dấu phẩy (,) |
Ví dụ fields:
id,user_username,display_name,department_name,user_avatar,user_email,contact_mobile
Phản hồi
Trạng thái: 200 OK
Cấu trúc phản hồi
{
"id": 12,
"user_username": "nguyenvana",
"display_name": "Nguyễn Văn A",
"department_name": "Kinh doanh",
"user_avatar": "https://...jpg",
"user_email": "[email protected]",
"contact_mobile": "0901234567"
}
Mô tả các trường
| Trường | Kiểu dữ liệu | Mô tả |
|---|---|---|
id | integer | ID duy nhất của user |
user_username | string | Tên đăng nhập của user |
display_name | string | Tên hiển thị |
department_name | string | Tên phòng ban |
user_avatar | string (URL) | Ảnh đại diện |
user_email | string | |
contact_mobile | string | Số điện thoại liên hệ |
Ghi chú
- API trả về object đơn, không phải mảng như API danh sách user.
- Trường
user_usernamelà duy nhất trong hệ thống. - Nếu không truyền
fields, hệ thống có thể trả về tập trường mặc định. - Phù hợp dùng cho màn hình User Profile, Assign User, Approval flow.
Ví dụ cURL
curl --location 'https://<ten-mien>/api/v6.1/user?user_username=lambinhchi&fields=id,user_username,display_name,department_name,user_avatar,user_email,contact_mobile' \
--header 'X-API-KEY: <api-key>'
Xử lý lỗi
| Mã lỗi | Mô tả |
|---|---|
| 401 | Không được xác thực – sai hoặc thiếu API key |
| 403 | Không có quyền truy cập API |
| 404 | Không tìm thấy user tương ứng |
| 500 | Lỗi hệ thống nội bộ |