Danh sách
Lấy thông tin các khách hàng có trong hệ thống
HTTP Request
GET /api/v3/accounts
Query Parameters
Parameter | Default | Description |
---|---|---|
q | blank | Điều kiện tìm kiếm, có thể là tên khách hàng, địa chỉ, email, số điện thoại |
limit | 50 | Giới hạn số bản ghi trả về |
page | 1 | Trang hiện tại |
custom_fields | null | Các điều kiện tìm kiếm theo các trường định nghĩa dữ liệu |
custom_field_list | null | Các trường định nghĩa dũ liệu cần lấy |
Riêng điều kiện tìm kiếm theo custom field có đôi chút đặt biệt
Ví dụ: custom_fields[chang_bay_du_kien] = "like|hanoi"
Trong đó
- chang_bay_du_kien: tên custom field cần tìm kiếm
- like|hanoi: là điều kiện và giá trị tìm kiếm cách nhau bằng dấu
"|"
- Các điều kiện tìm kiếm hỗ trợ bao gồm
">", ">=", "<", "<=", "like", "="
- Có thể tìm kiếm nhiều custom field trong một lần tìm kiếm, khi đó kết quả trả về sẽ theo phép toán và (AND)
Điều kiện custom_field_list sẽ truyền mã của các trường custom field, cách nhau bởi dấu phẩy
Ví dụ: custom_field_list = "chang_bay_du_kien,nguoi_van_chuyen"
Response
{
"records": [
{
"account_id": "13989",
"account_code": "KH13989",
"account_name": "Cty ĐT và PT Nam Trường Giang",
"address": "",
"phone": "0436554788",
"email": "",
"website": "",
"logo": "https://sample.getflycrm.com/assets/images/noavatar.png",
"birthday": "0000-00-00",
"description": "",
"created_at": "2016-12-14 08:20:00",
"account_type": "",
"ngay_ky_hd": null,
"truong_": null,
"lop": null,
"chang_bay_du_kien": null,
"ngay_xuat_ve": null,
"nhom_hang": null,
"contacts": [
{
"contact_id": "14007",
"first_name": "Nguyễn Văn Nam",
"last_name": null,
"phone_mobile": "0906221583",
"email": "[email protected]",
"description": null,
"title": null
},
{
"contact_id": "14069",
"first_name": "Trần Hoài Thu",
"last_name": null,
"phone_mobile": "",
"email": null,
"description": null,
"title": null
}
]
},
{}
],
"pagination": {
"page": 2,
"total_record": 629,
"total_page": 13
}
}