Chi tiết khách hàng
1. Tổng quan
API này dùng để lấy thông tin chi tiết của một khách hàng từ hệ thống CRM.
- Endpoint:
/api/v6.1/account?fields=....
- Phương thức:
GET
- Xác thực: Cần gửi
X-API-KEY
trong header
2. Request
curl --location 'https://linhpq.getflycrm.com/api/v6.1/account?account_code=KH%2F2025%2F011987&fields=id%2Caccount_code%2Caccount_name%2Cdescription%2Cbilling_address_street%2Cphone_office%2Cemail%2Cmgr_email%2Cmgr_display_name%2Cwebsite%2Clogo%2Cbirthday%2Csic_code%2Ccreated_at%2Cupdated_at%2Caccount_type%2Caccount_source%2Crelation_id%2Crelation_name%2Cgender%2Ctotal_revenue%2Ccontacts%2Cdetail_custom_fields%2Ccountry_name%2Cindustry_names%2Ccountry_id%2Cprovince_id%2Cdistrict_id%2Cward_id%2Cindustry%2Caccount_manager%2Caccessible_user_ids%2Caccount_type_details%2Ccountry_detail%2Cprovince_detail%2Cdistrict_detail%2Cward_detail%2Cgender_detail%2Caccount_source_details%2Cindustry_details%2Caccount_relation_detail' \
--header 'X-API-KEY: ADP8QgZR2f0ddxxxxxxxxxxxxxxxxxxxxx' \
--data ''
2.1. Headers
Tên | Loại | Mô tả |
---|---|---|
X-API-KEY | String | API Key để xác thực |
2.2. Query Parameters
Trường | Loại | Mô tả |
---|---|---|
account_code | string | Mã khách hàng |
fields | string | Danh sách các trường dữ liệu muốn lấy |
3. Response
3.1. Mô tả các trường dữ liệu
Trường | Loại | Mô tả |
---|---|---|
id | integer | Định danh khách hàng |
account_code | string | Mã khách hàng |
account_name | string | Tên khách hàng |
description | string | Mô tả chi tiết về khách hàng |
billing_address_street | string | Địa chỉ khách hàng |
phone_office | string | Số điện thoại văn phòng |
email | string | Email khách hàng |
mgr_email | string | Email của người quản lý khách hàng |
mgr_display_name | string | Tên hiển thị của người quản lý |
website | string | Website của khách hàng |
logo | string | URL ảnh logo khách hàng |
birthday | timestamp | Ngày sinh của khách hàng |
sic_code | string | Mã số thuế khách hàng |
created_at | timestamp | Ngày tạo tài khoản khách hàng |
updated_at | timestamp | Ngày cập nhật gần nhất |
account_type | array | Danh sách loại khách hàng (ID) |
account_source | array | Danh sách nguồn khách hàng (ID) |
relation_id | integer | ID mối quan hệ khách hàng |
relation_name | string | Tên mối quan hệ khách hàng |
gender | integer | Giới tính khách hàng (1: Nam, 2: Nữ, 3: Khác) |
total_revenue | numeric | Tổng doanh thu khách hàng |
country_name | string | Quốc gia khách hàng |
province_id | integer | ID tỉnh/thành phố |
district_id | integer | ID quận/huyện |
ward_id | integer | ID phường/xã |
industry | array | Danh sách ngành nghề (ID) |
account_manager | integer | ID người quản lý khách hàng |
detail_custom_fields | object | Các trường thông tin tùy chỉnh do hệ thống hoặc người dùng thêm |
contacts | array | Danh sách thông tin liên hệ của khách hàng |
account_type_details | array | Chi tiết về loại khách hàng (ID & Tên) |
account_source_details | array | Chi tiết về nguồn khách hàng (ID & Tên) |
industry_details | array | Chi tiết về ngành nghề khách hàng (ID & Tên) |
account_relation_detail | object | Thông tin chi tiết về mối quan hệ khách hàng |
gender_detail | object | Thông tin chi tiết về giới tính khách hàng |
country_detail | object | Chi tiết quốc gia của khách hàng |
province_detail | object | Chi tiết tỉnh/thành phố của khách hàng |
district_detail | object | Chi tiết quận/huyện của khách hàng |
ward_detail | object | Chi tiết phường/xã của khách hàng |
3.2. Cấu trúc JSON trả về
{
"id": 12037,
"account_code": "KH/2025/011987",
"account_name": "Tên khách hàng",
"description": "",
"billing_address_street": "",
"phone_office": "",
"email": "",
"mgr_email": "[email protected]",
"mgr_display_name": "Tên quản lý",
"website": "",
"logo": "",
"birthday": null,
"sic_code": "",
"created_at": "2025-02-25 09:12:32",
"updated_at": "2025-03-06 17:34:43",
"account_type": [1,5,7,6],
"account_source": [3,5,6],
"relation_id": 4,
"relation_name": "Tiềm năng",
"gender": 3,
"total_revenue": 450000,
"country_name": "Việt Nam",
"country_id": 1,
"province_id": 1,
"district_id": 3,
"ward_id": 86,
"industry": [2,4,7],
"account_manager": 2,
"detail_custom_fields": {
"ngay_giai_ngan": "1736182800",
"Chu_ky": "",
"Ma_don_hang": "",
"Ngay_Phong_Van_": null,
"so_serial": "",
"dia_chi_hoa_don": "",
"chi_nhanh": ""
},
"contacts": [
{
"id": 9803,
"account_id": 12037,
"first_name": "Tên liên hệ",
"phone_home": "",
"email": "",
"is_primary": 1
}
],
"account_type_details": [
{"id": 1, "label": "Hype"},
{"id": 5, "label": "Khó tính"}
],
"account_source_details": [
{"id": 3, "label": "Ladipage"},
{"id": 6, "label": "Tự kiếm"}
],
"industry_details": [
{"id": 2, "label": "May mặc"},
{"id": 4, "label": "Khởi nghiệp"}
],
"account_relation_detail": {"id": 4, "label": "Tiềm năng"},
"gender_detail": {"id": 3, "label": "Khác"},
"country_detail": {"id": 1, "label": "Việt Nam"},
"province_detail": {"id": 1, "label": "Hà Nội"},
"district_detail": {"id": 3, "label": "Hai Bà Trưng"},
"ward_detail": {"id": 86, "label": "Phường XYZ"}
}
4. Lưu ý
- API yêu cầu xác thực bằng
X-API-KEY
. - Cần cung cấp
account_code
để lấy thông tin khách hàng cụ thể. - Dữ liệu trả về bao gồm thông tin chi tiết về khách hàng, loại khách hàng, nguồn khách hàng, ngành nghề, mối quan hệ, v.v.
Tài liệu này cung cấp thông tin chi tiết về API lấy thông tin khách hàng, giúp dễ dàng tích hợp vào hệ thống.