客户列表
GET
/crm-customer
接口描述
用于获取客户列表。
请求头
参数名
类型
描述
必填
Device-Type
string
设备类型,示例:web
必填
Authorization
string
Token,示例:a3f2f638-5035-4bbe-ba12-8a5a6469ef2f
必填
请求参数
参数名
类型
描述
必填
page
int
分页页码,示例:1,默认:1
可选
limit
int
分页数量,示例:10,默认:10
可选
sort
string
排序字段,示例:id,可选值:{"id":"ID"},默认:id
可选
order
string
排序规则,示例:asc,可选值:{"asc":"升序","desc":"降序"},默认:asc
可选
id
int
客户ID,示例:1,搜索方式:等于
可选
customer_no
string
客户编码,示例:KH-1,搜索方式:模糊
可选
name
string
客户名称,示例:全联集采,搜索方式:模糊
可选
name_en
string
客户名称 (英文),示例:,搜索方式:模糊
可选
owner_id
int
负责人ID,示例:1,搜索方式:等于
可选
before_owner_id
int
前负责人ID,示例:1,搜索方式:等于
可选
source
string
客户来源,示例:公司资源,搜索方式:模糊
可选
mobile
int
手机号,示例:138888888888,搜索方式:模糊
可选
phone
int
电话号,示例:1388888,搜索方式:模糊
可选
web_site
string
网址,示例:https://baidu.com,搜索方式:模糊
可选
email
string
邮箱,示例:qljc@email.com,搜索方式:模糊
可选
industry
string
客户行业,示例:水产,搜索方式:模糊
可选
level
string
客户级别,示例:A,搜索方式:等于
可选
next_contact_time[0]
string
开始下次联系时间,示例:2021-07-16 00:00:00,搜索方式:范围|大于等于
可选
next_contact_time[1]
string
结束下次联系系时间,示例:2021-07-16 23:59:59,搜索方式:范围|小于等于
可选
tax_number
int
税号,示例:451266736481,搜索方式:模糊
可选
deposit_bank
string
开户行,示例:工商银行,搜索方式:模糊
可选
deposit_account
int
开户账号,示例:6412574123687982,搜索方式:模糊
可选
area_id_path
int
地区ID路径,示例:1,搜索方式:右模糊
可选
area_id
int
地区ID,示例:1,搜索方式:等于
可选
address
string
详细地址,示例:金沙湾,搜索方式:模糊
可选
address_en
string
详细地址 (英文),示例:,搜索方式:模糊
可选
lng
int
经度,示例:0,搜索方式:等于
可选
lat
int
纬度,示例:0,搜索方式:等于
可选
remark
string
备注,示例:重点客户,搜索方式:模糊
可选
create_time[0]
string
开始创建时间,示例:2021-07-16 00:00:00,搜索方式:范围|大于等于
可选
create_time[1]
string
结束创建时间,示例:2021-07-16 23:59:59,搜索方式:范围|小于等于
可选
is_attention
int
是否已关注,示例:1,可选值:{"0":"未关注","1":"已关注"}
可选
name_keyword
string
客户名称关键字,示例:全联集采,搜索方式:模糊,搜索字段:{"name":"客户名称","name_en":"客户名称 (英文)"}
可选
address_keyword
string
详细地址关键字,示例:金沙湾,搜索方式:模糊,搜索字段:{"address":"详细地址","address_en":"详细地址 (英文)"}
可选
keyword
string
关键字,示例:全联,搜索方式:模糊,搜索字段:{"customer_no":"客户编码","name":"客户名称","name_en":"客户名称 (英文)","mobile":"手机","phone":"电话","email":"邮箱"}
可选
响应参数
参数名
类型
描述
必填
total
int
数据总数,示例:1
必填
per_page
int
每页数量,示例:10
必填
current_page
int
当前一页页码,示例:1
必填
last_page
int
最后一页页码,示例:1
必填
id
int
客户ID,示例:1
必填
customer_no
string
客户编码,示例:KH-1
必填
name
string
客户名称,示例:全联集采水产品(广东)股份有限公司
必填
name_en
string
名称 (英文),示例:Quanlian Aquatic Products Collection (Guangdong) Co., Ltd.
必填
owner_id
object
负责人ID,示例:null
必填
before_owner_id
object
前负责人,示例:null
必填
source
string
客户来源,示例:
必填
mobile
string
手机号,示例:
必填
phone
string
电话号,示例:
必填
web_site
string
网址,示例:
必填
email
string
邮箱,示例:
必填
industry
string
客户行业,示例:
必填
level
string
客户级别,示例:
必填
next_contact_time
object
下次联系时间,示例:null
必填
tax_number
string
税号,示例:
必填
deposit_bank
string
开户行,示例:
必填
deposit_account
string
开户账号,示例:
必填
area_id_path
object
地区ID路径,示例:null
必填
area_id
object
地区ID,示例:null
必填
address
string
详细地址,示例:湛江开发区人民大道中34号开发区财政局3楼301房
必填
address_en
string
详细地址 (英文),示例:Room 301,3th floor, Finance Bureau, No. 34 People's Avenue, Zhanjiang Development District,Guangdong
必填
lng
object
经度,示例:null
必填
lat
object
纬度,示例:null
必填
remark
string
备注,示例:
必填
admin_id
int
创建人ID,示例:2
必填
create_time
string
创建时间,示例:2021-07-16 16:12:43
必填
update_time
string
更新时间,示例:2021-07-16 16:12:43
必填
is_attention
bool
是否关注,示例:false,说明:false为未关注,true为已关注
必填
purchase_contract_count
int
采购合同统计数量,示例:5,说明:可根据此参数判断是否可以删除,条件:>0不能删除;<1可以删除
必填
area_text
string
地区文本,示例:广东省,湛江市,赤坎区,说明:默认不返回国家层级
必填