文档
测试

线索列表

GET
/crm-clue

接口描述

用于获取线索列表。

请求头

参数名
类型
描述
必填
Device-Type
string
设备类型,示例:web
必填
Authorization
string
Token,示例:fafaf139-37b8-4d1e-abc3-65d9901697c5
必填

请求参数

参数名
类型
描述
必填
page
int
分页页码,示例:1,默认:1
可选
limit
int
分页数量,示例:10,默认:10
可选
sort
string
排序字段,示例:id,可选值:{"id":"ID"},默认:id
可选
order
string
排序规则,示例:asc,可选值:{"asc":"升序","desc":"降序"},默认:asc
可选
keyword
string
关键字,示例:8,搜索方式:%模糊%,搜索字段:{"name":"线索名称","mobile":"手机","telephone":"电话"}
可选
scene_id
int
示例:6
可选
filters
array
高级筛选列表
可选
field_name
string
字段显示名,示例:name
必填
op
string
查询表达式,示例:LIKE,可选值:{"=":"等于","<>":"不等于","LIKE":"模糊","NOT LIKE":"不在模糊",">":"大于",">=":"大于等于","<":"小于","<=":"小于等于","BETWEEN":"范围","NOT BETWEEN":"不在范围"}
必填
condition
array
查询条件列表
必填
0
string
查询条件,示例:名称%
必填
form_type
string
字段类型,示例:text,可选值:{"text":"文本","number":"数字","date":"日期","datetime":"日期时间"}
必填
filters[0][field_name]
string
字段显示名,示例:name
可选
filters[0][op]
string
查询表达式,示例:LIKE,可选值:{"=":"等于","<>":"不等于","LIKE":"模糊","NOT LIKE":"不在模糊",">":"大于",">=":"大于等于","<":"小于","<=":"小于等于","BETWEEN":"范围","NOT BETWEEN":"不在范围"}
可选
filters[0][condition][0]
string
查询条件,示例:名称%
可选
filters[0][form_type]
string
字段类型,示例:text,可选值:{"text":"文本","number":"数字","date":"日期","datetime":"日期时间"}
可选

响应参数

application/json
参数名
类型
描述
必填
paging
object
分页对象
必填
total
int
数据总数,示例:1
必填
per_page
int
每页数量,示例:10
必填
current_page
int
当前一页页码,示例:1
必填
last_page
int
最后一页页码,示例:1
必填
data
array
数据列表
必填
id
int
线索ID,示例:1
必填
name
string
线索名称,示例:遗漏的物品
必填
industry
string
客户行业,示例:IT/通信/电子/互联网
必填
level
string
客户级别,示例:A(重点客户)
必填
source
string
客户来源,示例:展会资源
必填
next_time
string
下次联系时间,示例:2021-10-13 09:00:00
必填
telephone
string
电话,示例:8888888
必填
mobile
string
手机,示例:88888888888
必填
email
string
邮箱,示例:88888888888@email.com
必填
area_id
int
地区ID,示例:100
必填
area_id_path
string
地区ID路径,示例:1,2,91,100
必填
address
string
详细地址,示例:海湾街道 民大中心
必填
remark
string
备注,示例:请单证部尽快联系该线索。
必填
owner_admin_id
int
负责人ID,示例:2
必填
create_admin_id
int
创建人ID,示例:2
必填
create_time
string
创建时间,示例:2021-10-12 16:32:42
必填
update_time
string
更新时间,示例:2021-10-12 16:32:42
必填
area_name
string
地区名称,示例:广东省湛江市赤坎区
必填
owner_admin_nickname
string
负责人昵称,示例:郑嘉俊
必填
owner_admin_avatar
string
负责人头像,说明:Url链接或Base64
必填
create_admin_nickname
string
创建人昵称,示例:郑嘉俊
必填
create_admin_avatar
string
创建人头像,说明:Url链接或Base64
必填

说明 / 示例

**依赖接口 (调用顺序):** [场景列表](doc:7aFUkF9w) [线索字段列表](doc:sOjW24Q3)