Danh sách

Lấy thông tin các khách hàng có trong hệ thống

HTTP Request

[GET] /api/v6/accounts

Query Parameters

Fields

Fields	Type	Description
id	integer	Định danh
account_code	string	Mã khách hàng
account_name	string	Tên khách hàng
description	string	Mô tả
billing_address_street	string	Địa chỉ
phone_office	numeric	Số điện thoại khách hàng
email	string	Email khách hàng
mgr_email	string	Email quản lý
mgr_display_name	string	Tên quản lý
website	string	Website
logo	string	Ảnh khách hàng
birthday	timestamp	Sinh nhật
sic_code	string	Mã số thuế
created_at	timestamp	Ngày tạo
account_type	string	Loại khách hàng
account_source	string	Nguồn khách hàng
relation_id	integer	Định danh mối quan hệ
relation_name	string	Tên mối quan hệ
gender	string	Giới tính
total_revenue	float	Tổng doanh thu
contacts	array	Các liên hệ
account_manager	integer	Người phụ trách khách hàng
accessible_user_ids	array	Người liên quan
custom_fields	object	Các trường đã định nghĩa

Filtering

Fields	Support	Type	Description
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_fax	eq,contains	numeric	Số fax
contact_phone	eq	numeric	Số điện thoại liên hệ 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ỉ
phone_office	eq,contains	numeric	Số điện thoại
birthday	eq,gte,lte	timestamp	Sinh nhật
birthday_day	eq,gte,lte	integer	Ngày sinh nhật
birthday_month	eq	integer	Tháng sinh nhật
birthday_year	eq	integer	Năm sinh nhật
website	eq,contains	string	Website
sic_code	eq,contains	string	Mã số thuế
valid	is,in	bool	Hợp lệ không
email	eq,contains	string	Email
description	eq,contains	string	Mô tả
country_id	eq	integer	Quốc gia
province_id	eq	integer	Tỉnh/Thành
district_id	eq	integer	Quận/Huyện
account_manager	eq,in,not_in	integer	Người quản lý
source_type	eq	string	Loại nguồn
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
creator_id	eq	integer	Người tạo
email_unsubcribe	eq	bool	Hủy nhận email
referrer_id	eq	integer	Định danh người giới thiệu
contact_id	eq	integer	Định danh liên hệ
contact_name	eq,contains	string	Tên liên hệ
contact_phone	eq,contains	numeric	Số liên hệ
contact_email	eq,contains	string	Email liên hệ
has_sale_order	is	bool	Đã có đơn hàng
sale_order_status	eq,in	integer	Trạng thái đơn hàng
sale_order_date	eq,gte,lte,gt,lt,between,not_between	timestamp	Ngày phát sinh đơn hàng
has_purchase_order	is	bool	Đã có đơn hàng bán
purchase_order_date	eq,gte,lte,gt,lt,between,not_between	timestamp	Ngày phát sinh đơn hàng bán
campaign_id	eq	integer	Chiến dịch
opportunity_status_id	eq,in	integer	Trạng thái cơ hội
opportunity_created_at	eq,gt,gte,lt,lte	timestamp	Ngày tạo cơ hội

Sort

Sort (field)	Direction
id	asc,desc
account_name	asc,desc
account_code	asc,desc
email	asc,desc

Limit & Offset

	Type	Description
Limit	integer	Lấy bao nhiêu bản ghi
Offset	integer	Bỏ qua bao nhiêu bản ghi

Example

HTTP Request

GET api/v6/accounts?fields=account_name,custom_fields&filtering[id]=4&limit=1&offset=1 HTTP/1.1
Host: example.getflycrm.com
Content-Type: application/json

Status

200 OK

Response

{
  "data": [
    {
      "id": 4,
      "account_name": "TEST ACCOUNT API",
      "account_manager": 123,
      "accessible_user_ids": [1,2,3,4],
      "custom_fields": {
        "field_1": 111
      }
    }
  ],
  "has_more": false,
  "offset": 0,
  "limited": 1
}