- Development guideline
- Authentication
- Leads
- Contents
- Events
- Table Structure
- Behaviors-NEW
- Others
Get Leads List
Developing
POST
/leads/open-api/leads-list
客户数据平台(CDP)/线索Leads/高级筛选
Request
Query Params
access_token
string
optional
Body Params application/json
page_num
integer
页码
Example:
1
page_size
integer
每页展示条数
Example:
20
view_id
string
视图id
Example:
1
condition
object
搜索规则
type
string
optional
Example:
and
list
array [object {2}]
optional
user_id
string
用户ID
Example
{
"page_num": "1",
"page_size": "20",
"view_id": "1",
"condition": {
"type": "and",
"list": [
{
"type": "or",
"attribute": [
{
"field_name": "email",
"search_type": "like",
"value": "aaaa"
}
]
}
]
},
"user_id": "string"
}
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://openapi.beschannels.com/leads/open-api/leads-list?access_token' \
--header 'Content-Type: application/json' \
--data-raw '{
"page_num": "1",
"page_size": "20",
"view_id": "1",
"condition": {
"type": "and",
"list": [
{
"type": "or",
"attribute": [
{
"field_name": "email",
"search_type": "like",
"value": "aaaa"
}
]
}
]
},
"user_id": "string"
}'
Responses
🟢200successful request
application/json
Body
code
integer
optional
Example:
0
msg
string
optional
Example:
ok
data
object
required
header
object
required
total
integer
required
list
object
required
Example
{
"code": 0,
"msg": "成功",
"data": {
"header": [
{
"label": "姓名",
"prop": "FullName"
},
{
"label": "手机号",
"prop": "MobilePhone"
},
{
"label": "邮箱",
"prop": "Email"
},
{
"label": "公司",
"prop": "Company"
},
{
"label": "归属人",
"prop": "LeadOwner"
},
{
"label": "创建时间",
"prop": "CreatedTime"
},
{
"label": "成为线索时间",
"prop": "LeadCreatedTime"
},
{
"label": "转出状态",
"prop": "TransferStatus"
},
{
"label": "首次访问推广来源",
"prop": "FirstUTMSource"
},
{
"label": "最近访问推广来源",
"prop": "LatestUTMSource"
},
{
"label": "线索阶段",
"prop": "LeadStage"
}
],
"total": 76184,
"list": [
{
"id": 3971776,
"one_id": "a5f279c7e3f74f8d8d41def4dab04a0a",
"rollout_status": 1,
"FullName": "whh-openapi",
"MobilePhone": "13123459843",
"Email": "",
"Company": "",
"LeadOwner": "",
"CreatedTime": "2023-01-09 10:53:15",
"LeadCreatedTime": "2023-01-09 10:53:15",
"TransferStatus": {
"id": 1,
"label": "培育中"
},
"FirstUTMSource": "",
"LatestUTMSource": "",
"LeadStage": ""
},
{
"id": 3967799,
"one_id": "03eb586497a44c5fad7d79a20e673403",
"rollout_status": 1,
"FullName": "彤-123456789101",
"MobilePhone": "15010858579",
"Email": "",
"Company": "",
"LeadOwner": "",
"CreatedTime": "2023-01-07 05:45:44",
"LeadCreatedTime": "2023-01-07 05:45:44",
"TransferStatus": {
"id": 1,
"label": "培育中"
},
"FirstUTMSource": "",
"LatestUTMSource": "",
"LeadStage": ""
},
{
"id": 3965891,
"one_id": "c6186a6a3fc4492691c87b4be05b80d0",
"rollout_status": 1,
"FullName": "13217651239-update1",
"MobilePhone": "13217651239",
"Email": "",
"Company": "",
"LeadOwner": "",
"CreatedTime": "2023-01-06 22:21:47",
"LeadCreatedTime": "2023-01-06 22:21:47",
"TransferStatus": {
"id": 1,
"label": "培育中"
},
"FirstUTMSource": "",
"LatestUTMSource": "",
"LeadStage": ""
},
{
"id": 3965116,
"one_id": "6edfae641af54f78a2a9d050eb992a5a",
"rollout_status": 1,
"FullName": "18812348743",
"MobilePhone": "18812348743",
"Email": "",
"Company": "",
"LeadOwner": "",
"CreatedTime": "2023-01-06 20:31:00",
"LeadCreatedTime": "2023-01-06 20:31:00",
"TransferStatus": {
"id": 1,
"label": "培育中"
},
"FirstUTMSource": "",
"LatestUTMSource": "",
"LeadStage": ""
},
{
"id": 3964436,
"one_id": "30751113f8164945948e832d64a6dc71",
"rollout_status": 1,
"FullName": "18812348742",
"MobilePhone": "18812348742",
"Email": "",
"Company": "",
"LeadOwner": "",
"CreatedTime": "2023-01-06 20:03:59",
"LeadCreatedTime": "2023-01-06 20:03:59",
"TransferStatus": {
"id": 1,
"label": "培育中"
},
"FirstUTMSource": "",
"LatestUTMSource": "",
"LeadStage": ""
},
{
"id": 3886726,
"one_id": "a21646c7196f4759b1815af8d31595ed",
"rollout_status": 1,
"FullName": "导入2",
"MobilePhone": "15010012121",
"Email": "test1@test2.com",
"Company": "",
"LeadOwner": "",
"CreatedTime": "2023-01-06 14:51:59",
"LeadCreatedTime": "2023-01-06 14:51:59",
"TransferStatus": {
"id": 1,
"label": "培育中"
},
"FirstUTMSource": "",
"LatestUTMSource": "",
"LeadStage": ""
},
{
"id": 3886727,
"one_id": "20268b5ac2c740c6b10d7dc6abc8c70a",
"rollout_status": 1,
"FullName": "导入3",
"MobilePhone": "15010012122",
"Email": "test1@test3.com",
"Company": "",
"LeadOwner": "",
"CreatedTime": "2023-01-06 14:51:59",
"LeadCreatedTime": "2023-01-06 14:51:59",
"TransferStatus": {
"id": 1,
"label": "培育中"
},
"FirstUTMSource": "",
"LatestUTMSource": "",
"LeadStage": ""
},
{
"id": 3881715,
"one_id": "238d7635c56b4e238dd03f8c4f3377fd",
"rollout_status": 1,
"FullName": "曹女士",
"MobilePhone": "15601697705",
"Email": "",
"Company": "",
"LeadOwner": "",
"CreatedTime": "2023-01-05 20:45:13",
"LeadCreatedTime": "2023-01-05 20:45:13",
"TransferStatus": {
"id": 1,
"label": "培育中"
},
"FirstUTMSource": "",
"LatestUTMSource": "",
"LeadStage": ""
},
{
"id": 3881716,
"one_id": "5445ec40568e45f0b79f7fec27c84822",
"rollout_status": 1,
"FullName": "白鹭",
"MobilePhone": "15199660991",
"Email": "",
"Company": "",
"LeadOwner": "",
"CreatedTime": "2023-01-05 20:45:13",
"LeadCreatedTime": "2023-01-05 20:45:13",
"TransferStatus": {
"id": 1,
"label": "培育中"
},
"FirstUTMSource": "",
"LatestUTMSource": "",
"LeadStage": ""
},
{
"id": 3881717,
"one_id": "9f104b3344134e47b67ec7a3f102ac6f",
"rollout_status": 1,
"FullName": "陈陈",
"MobilePhone": "13435250389",
"Email": "",
"Company": "",
"LeadOwner": "",
"CreatedTime": "2023-01-05 20:45:13",
"LeadCreatedTime": "2023-01-05 20:45:13",
"TransferStatus": {
"id": 1,
"label": "培育中"
},
"FirstUTMSource": "",
"LatestUTMSource": "",
"LeadStage": ""
},
{
"id": 3881718,
"one_id": "278ac20576c5436da8d92fa3d13a2ee9",
"rollout_status": 1,
"FullName": "唐俏娟",
"MobilePhone": "18338993783",
"Email": "",
"Company": "",
"LeadOwner": "",
"CreatedTime": "2023-01-05 20:45:13",
"LeadCreatedTime": "2023-01-05 20:45:13",
"TransferStatus": {
"id": 1,
"label": "培育中"
},
"FirstUTMSource": "",
"LatestUTMSource": "",
"LeadStage": ""
},
{
"id": 3881719,
"one_id": "91aa796fa48546d097a2fb8c80403b48",
"rollout_status": 1,
"FullName": "helen",
"MobilePhone": "15080012800",
"Email": "",
"Company": "",
"LeadOwner": "",
"CreatedTime": "2023-01-05 20:45:13",
"LeadCreatedTime": "2023-01-05 20:45:13",
"TransferStatus": {
"id": 1,
"label": "培育中"
},
"FirstUTMSource": "",
"LatestUTMSource": "",
"LeadStage": ""
},
{
"id": 3881720,
"one_id": "3acd95df8b9f445ca12bb5ca45610426",
"rollout_status": 1,
"FullName": "李爽",
"MobilePhone": "15903894999",
"Email": "",
"Company": "",
"LeadOwner": "",
"CreatedTime": "2023-01-05 20:45:13",
"LeadCreatedTime": "2023-01-05 20:45:13",
"TransferStatus": {
"id": 1,
"label": "培育中"
},
"FirstUTMSource": "",
"LatestUTMSource": "",
"LeadStage": ""
},
{
"id": 3881721,
"one_id": "101ee1762b764caebf33c9d555415569",
"rollout_status": 1,
"FullName": "陈伟",
"MobilePhone": "13929549028",
"Email": "",
"Company": "",
"LeadOwner": "",
"CreatedTime": "2023-01-05 20:45:13",
"LeadCreatedTime": "2023-01-05 20:45:13",
"TransferStatus": {
"id": 1,
"label": "培育中"
},
"FirstUTMSource": "",
"LatestUTMSource": "",
"LeadStage": ""
},
{
"id": 3881722,
"one_id": "d1353710281c41f795330d049a32a414",
"rollout_status": 1,
"FullName": "于靓",
"MobilePhone": "18621608416",
"Email": "",
"Company": "",
"LeadOwner": "",
"CreatedTime": "2023-01-05 20:45:13",
"LeadCreatedTime": "2023-01-05 20:45:13",
"TransferStatus": {
"id": 1,
"label": "培育中"
},
"FirstUTMSource": "",
"LatestUTMSource": "",
"LeadStage": ""
},
{
"id": 3881723,
"one_id": "f27e5ff10a2c4b78bcfbce329899086b",
"rollout_status": 1,
"FullName": "梅素敏",
"MobilePhone": "18721351913",
"Email": "",
"Company": "",
"LeadOwner": "",
"CreatedTime": "2023-01-05 20:45:13",
"LeadCreatedTime": "2023-01-05 20:45:13",
"TransferStatus": {
"id": 1,
"label": "培育中"
},
"FirstUTMSource": "",
"LatestUTMSource": "",
"LeadStage": ""
},
{
"id": 3881724,
"one_id": "0f05868228844d4e84a2b1fd46be6fc2",
"rollout_status": 1,
"FullName": "南丁",
"MobilePhone": "18683379276",
"Email": "",
"Company": "",
"LeadOwner": "",
"CreatedTime": "2023-01-05 20:45:13",
"LeadCreatedTime": "2023-01-05 20:45:13",
"TransferStatus": {
"id": 1,
"label": "培育中"
},
"FirstUTMSource": "",
"LatestUTMSource": "",
"LeadStage": ""
},
{
"id": 3881725,
"one_id": "6f6a6f21d4544150b22f80fc37d9b7a3",
"rollout_status": 1,
"FullName": "谢丽云",
"MobilePhone": "18064075620",
"Email": "",
"Company": "",
"LeadOwner": "",
"CreatedTime": "2023-01-05 20:45:13",
"LeadCreatedTime": "2023-01-05 20:45:13",
"TransferStatus": {
"id": 1,
"label": "培育中"
},
"FirstUTMSource": "",
"LatestUTMSource": "",
"LeadStage": ""
},
{
"id": 3881726,
"one_id": "02fbfe70cc2340098889173ceeed565e",
"rollout_status": 1,
"FullName": "王凯文",
"MobilePhone": "13917432990",
"Email": "",
"Company": "",
"LeadOwner": "",
"CreatedTime": "2023-01-05 20:45:13",
"LeadCreatedTime": "2023-01-05 20:45:13",
"TransferStatus": {
"id": 1,
"label": "培育中"
},
"FirstUTMSource": "",
"LatestUTMSource": "",
"LeadStage": ""
},
{
"id": 3881727,
"one_id": "f6561850c6ca43ad8f6cef0cabc4c0c5",
"rollout_status": 1,
"FullName": "金晶",
"MobilePhone": "13758118012",
"Email": "",
"Company": "",
"LeadOwner": "",
"CreatedTime": "2023-01-05 20:45:13",
"LeadCreatedTime": "2023-01-05 20:45:13",
"TransferStatus": {
"id": 1,
"label": "培育中"
},
"FirstUTMSource": "",
"LatestUTMSource": "",
"LeadStage": ""
}
]
}
}
Modified at 2023-06-08 09:17:36