Chuyển tới nội dung chính

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ênLoạiMô tả
X-API-KEYStringAPI Key để xác thực

2.2. Query Parameters

TrườngLoạiMô tả
account_codestringMã khách hàng
fieldsstringDanh 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ườngLoạiMô tả
idintegerĐịnh danh khách hàng
account_codestringMã khách hàng
account_namestringTên khách hàng
descriptionstringMô tả chi tiết về khách hàng
billing_address_streetstringĐịa chỉ khách hàng
phone_officestringSố điện thoại văn phòng
emailstringEmail khách hàng
mgr_emailstringEmail của người quản lý khách hàng
mgr_display_namestringTên hiển thị của người quản lý
websitestringWebsite của khách hàng
logostringURL ảnh logo khách hàng
birthdaytimestampNgày sinh của khách hàng
sic_codestringMã số thuế khách hàng
created_attimestampNgày tạo tài khoản khách hàng
updated_attimestampNgày cập nhật gần nhất
account_typearrayDanh sách loại khách hàng (ID)
account_sourcearrayDanh sách nguồn khách hàng (ID)
relation_idintegerID mối quan hệ khách hàng
relation_namestringTên mối quan hệ khách hàng
genderintegerGiới tính khách hàng (1: Nam, 2: Nữ, 3: Khác)
total_revenuenumericTổng doanh thu khách hàng
country_namestringQuốc gia khách hàng
province_idintegerID tỉnh/thành phố
district_idintegerID quận/huyện
ward_idintegerID phường/xã
industryarrayDanh sách ngành nghề (ID)
account_managerintegerID người quản lý khách hàng
detail_custom_fieldsobjectCác trường thông tin tùy chỉnh do hệ thống hoặc người dùng thêm
contactsarrayDanh sách thông tin liên hệ của khách hàng
account_type_detailsarrayChi tiết về loại khách hàng (ID & Tên)
account_source_detailsarrayChi tiết về nguồn khách hàng (ID & Tên)
industry_detailsarrayChi tiết về ngành nghề khách hàng (ID & Tên)
account_relation_detailobjectThông tin chi tiết về mối quan hệ khách hàng
gender_detailobjectThông tin chi tiết về giới tính khách hàng
country_detailobjectChi tiết quốc gia của khách hàng
province_detailobjectChi tiết tỉnh/thành phố của khách hàng
district_detailobjectChi tiết quận/huyện của khách hàng
ward_detailobjectChi 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.