查询企业列表 - 尘锋SCRM开放平台

POST https://qw-openapi-tx.dustess.com/enterprise/v2/list?accessToken=

Content-Type: application/json

接口限制：每分钟调用600次；

Params:

字段	类型	描述	是否必须
accessToken	`String`	accessToken	true

请求参数

请求参数名	类型	说明	是否必须
ids	`String[]`	企业ID列表 (单次不超过500)	false
owner_ids	`String[]`	跟进人ID列表 (单次不超过500)	false
create_time_start	`Int`	创建起始时间 (时间戳),如果要传start,end都必须传，未传时间区间默认查询最近一周，时间区间最长一个月）	false
create_time_end	`Int`	创建结束时间 (时间戳),如果要传start,end都必须传，未传时间区间默认查询最近一周，时间区间最长一个月）	false
update_time_start	`Int`	更新起始时间 (时间戳),如果要传start,end都必须传	false
update_time_end	`Int`	更新结束时间 (时间戳),如果要传start,end都必须传	false
page	`Int`	页码 (默认1)	false
page_size	`Int`	页长 (默认500,最大500)	false

注意

查询条件中没有指定时间范围，并且没有指定企业id和跟进人id的时候，默认查询最近一周创建的数据；

请求参数示例

{
	"ids": [
		"xxxx-xxx-xxx-xxx"
	],
	"create_time_start": 0,
	"create_time_end": 0,
	"update_time_start": 0,
	"update_time_end": 0,
	"page": 1,
	"page_size": 1000
}

成功响应

响应参数名	类型	说明
code	`Int`	响应码
msg	`String`	消息提示
data	`Object`	返回数据
data.list	`Object[]`	返回数据列表
data.list.id	`String`	查询的企业ID
data.list.name	`String`	企业简称
data.list.full_name	`String`	企业全称
data.list.category_id	`String`	企业类型id
data.list.category_name	`String`	企业类型名称
data.list.tel	`String`	企业电话
data.list.web	`String`	企业网址
data.list.prov_city	`String`	企业省市
data.list.peoples	`String`	企业规模
data.list.industry	`String`	行业
data.list.address	`String`	地址
data.list.level_id	`String`	企业等级ID
data.list.level_name	`String`	企业等级名称
data.list.tags	`String[]`	企业标签id
data.list.corp_code	`String`	企业编码
data.list.business_id	`String`	工商信息关联id
data.list.udf	`Object`	销售机会用户自定义字段
data.list.udf.model_data	`Object[]`	销售机会用户自定义字段数据集
data.list.udf.model_data[].key	`string`	字段业务ID
data.list.udf.model_data[].value	`string`	字段值：单行文本、多行文本、日期、日期时间类型值为字符串；数字、附件获取附件URL访问签名、单多选、多级联选单多选的值为json序列化后的字符串；日期类型字符串格式：`2021-06-01`；日期时间类型字符串格式：`2006-01-02 15:04:05`；附件为object数组，格式：`[{"name":"企业列表.xlsx","url":"https://xxx/xxx.xlsx","size":11085,"type":"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"}]`；单多选为字符串数组，格式：`["选项id"]`；多级联选单多选为字符串数组，格式：`["一级选项id/二级选项id"]`
data.list.create_user	`String`	创建人ID
data.list.create_time	`Int`	创建时间 (时间戳)
data.list.update_user	`String`	更新人ID
data.list.update_time	`Int`	更新时间 (时间戳)
data.list.owner_user	`String`	主跟进人ID
data.list.share_users	`String[]`	企业共享人IDs
data.list.status_id	`String`	跟进状态ID
data.list.status_name	`String`	跟进状态名称
data.list.pool_id	`String`	公海ID
data.list.pool_name	`String`	公海名称
data.list.source_id	`String`	来源ID
data.list.source_name	`String`	来源名称
data.list.cf_ts	`Int`	递增ID
data.count	`Int`	查询结果总条数

成功响应示例

{
  "code": 0,
  "msg": "OK",
  "data": {
    "list": [
      {
        "id": "xxxx-xxx-xxx-xxx",
        "name": "简称",
        "full_name": "企业全称",
        "category_id": "00000000-0000-0000-0000-000000000000",
        "category_name": "默认类型",
        "tel": "13777777777",
        "web": "http://www.xxxx.com",
        "prov_city": "四川-成都",
        "peoples": "1000人以上",
        "industry": "电商行业",
        "address": "xxx-xx-xxx",
        "level": "xxxx-xx-xx-xx",
        "tags": [],
        "corp_code": "",
        "business_id": "",
        "udf": {
          "model_data": [
            {
              "key": "f0ce66-lkroqp0e",
              "value": null // 代表空值
            },
            {
              "key": "tqlcsb-ll4uqr23",
              "value": "单行/多行传入值" // 单多行文本的值
            },
            {
              "key": "ytwhyh-ll4uqr23",
              "value": "2023-08-12" // 日期的值
            },
            {
              "key": "wbwsja-ll4uqr23",
              "value": "2023-08-15 14:00:00" // 时间日期的值
            },
            {
              "key": "c75noa-1h0hsvcb5",
              "value": "99" // 数字类型实例
            },
            {
              "key": "60mdnv-lhen3uic",
              "value": "[\"1\"]" // 单多选实例，单选仅有一个值，多选可有多个值
            },
            {
              "key": "75yey8-ljze44hq",
              // 多级联选实例，单选仅有一个值，多选可有多个值；每个值包含父级选项id，使用「/」分割选项id：一级选项id/二级选项id/三级选项id
              "value": "[\"1679051431107665933/1679051431107665934\",\"1679051431107665933/1679051431107665934/1679051431107665935/1679051431107665940\"]"
            },
            {
              "key": "ys8xs5-lk0vvuoy",
              // 附件字段实例
              "value": "[{\"name\":\"企业列表.xlsx\",\"url\":\"https://cdn-member-test.dustess.com/W00000000545/static/l/l/d/9/lld9nnx7p91692084131697.xlsx\",\"size\":11085,\"type\":\"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet\"]"
            }
          ]
        },
        "create_user": "541",
        "create_time": 1650263127,
        "update_user": "541",
        "update_time": 1650273922,
        "owner_user": "",
        "share_users": [],
        "status_id": "uuid5",
        "status_name": "无效",
        "pool_id": "xxxx-xxx-xxx-xxx",
        "source_id": "xxxx-xxx-xxx-xxx",
        "source_name": "xxxx",
        "cf_ts": 1230162216368480256
      }
    ],
    "count": 1
  }
}