Danh sách khách hàng

1. Tổng quan

API này dùng để lấy danh sách khách hàng từ hệ thống CRM.

Endpoint: /api/v6.1/accounts
Phương thức: GET
Xác thực: Cần gửi X-API-KEY trong header

2. Request

2.1. Headers

Tên	Loại	Mô tả
`X-API-KEY`	String	API Key để xác thực

2.2. Query Parameters

Lọc dữ liệu (Filtering)

API hỗ trợ nhiều bộ lọc để tìm kiếm khách hàng theo các tiêu chí cụ thể.

Trường	Toán tử	Loại	Mô tả
`id`	`eq, in, not_in`	integer	Định danh khách hàng
`account_code`	`eq, contains`	string	Mã khách hàng
`account_name`	`eq`	string	Tên khách hàng
`relation_id`	`eq, in, not_in`	integer	Mối quan hệ
`phone_office`	`eq, contains`	numeric	Số điện thoại
`email`	`eq, contains`	string	Email khách hàng
`account_type`	`eq, in, not_in`	string	Loại khách hàng
`account_source`	`eq, in`	string	Nguồn khách hàng
`industry`	`eq`	string	Đánh giá
`billing_address_street`	`eq, contains`	string	Địa chỉ
`created_at`	`eq, gte, lte, between`	timestamp	Ngày tạo
`updated_at`	`eq, gte, lte, between`	timestamp	Ngày sửa
`gender`	`eq`	integer	Giới tính
`account_manager`	`eq, in, not_in`	integer	Người quản lý
`sale_order_status`	`eq, in`	integer	Trạng thái đơn hàng

Sắp xếp dữ liệu (Sorting)

Trường	Giá trị
`id`	`asc, desc`
`account_name`	`asc, desc`
`account_code`	`asc, desc`
`email`	`asc, desc`

Phân trang (Limit & Offset)

Trường	Loại	Mô tả
`limit`	integer	Số lượng bản ghi cần lấy
`offset`	integer	Số lượng bản ghi cần bỏ qua

3. Request & Response

3.1. Ví dụ Request

curl --location 'https://xxxx.getflycrm.com/api/v6.1/accounts?fields=id,account_code,account_name,email&limit=1' \
--header 'X-API-KEY: YOUR_API_KEY' \
--data ''

3.2. Ví dụ Response

{
    "data": [
        {
            "id": 10001,
            "account_code": "KH/2025/000001",
            "account_name": "Công ty ABC",
            "description": "Khách hàng tiềm năng",
            "billing_address_street": "123 Đường XYZ, TP ABC",
            "phone_office": "0123456789",
            "email": "[email protected]",
            "website": "https://abc.com",
            "created_at": "2025-02-25 09:12:32",
            "updated_at": "2025-03-06 17:34:43",
            "account_type": [1, 5],
            "account_source": [3, 6],
            "relation_id": 4,
            "relation_name": "Khách hàng mới",
            "gender": 1,
            "total_revenue": 500000,
            "country_name": "Việt Nam",
            "province_id": 1,
            "district_id": 3,
            "ward_id": 86,
            "industry": [2, 4],
            "account_manager": 2,
            "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": 1, "label": "Nam"},
            "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"}
        }
    ],
    "has_more": true,
    "offset": 0,
    "limited": 1,
    "sorted": {"id": "DESC"}
}

Dữ liệu trả về dưới dạng JSON với mô tả đầy đủ các trường:

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
`website`	string	Website của khách hàng
`created_at`	timestamp	Ngày tài khoản khách hàng được tạo
`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
`contacts`	array	Danh sách thông tin liên hệ của khách hàng
`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
`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
`detail_custom_fields_display_value`	object	Giá trị hiển thị các trường tùy chỉnh
`last_active`	timestamp	Thời gian liên hệ lần cuối
`last_active_url`	string	Url liên hệ lần cuối
`last_active_desc`	string	Mô tả liên hệ lần cuối
`last_active_day`	integer	Số ngày kể từ lần liên hệ cuối

4. Lưu ý

API yêu cầu xác thực bằng X-API-KEY.
Có thể sử dụng bộ lọc để tìm kiếm khách hàng theo nhiều tiêu chí.
Mặc định sắp xếp theo id DESC, có thể thay đổi bằng tham số sort.

Tài liệu này cung cấp thông tin chi tiết về API lấy danh sách khách hàng, giúp dễ dàng tích hợp vào hệ thống.

1. Tổng quan​

2. Request​

2.1. Headers​

2.2. Query Parameters​

Lọc dữ liệu (Filtering)​

Sắp xếp dữ liệu (Sorting)​

Phân trang (Limit & Offset)​

3. Request & Response​

3.1. Ví dụ Request​

3.2. Ví dụ Response​

4. Lưu ý​