open-api
首页
open-api
  • 快速开始
  • 授权登录
  • 客户
    • 客户
    • 客户列表GET
    • 跟进动态查询接口GET
    • 提交跟进动态POST
    • 客户分组新增/编辑POST
    • 删除客户分组POST
    • 客户阶段新增/编辑POST
    • 删除客户阶段POST
    • 客户标签新增/编辑POST
    • 删除客户标签POST
    • 客户枚举:客户类型,客户标签,时区,规模,星级,采购意向,采购额度,职级GET
    • 客户数据字典GET
    • 客户(含联系人)新增/编辑POST
    • 删除客户(仅支持公海客户)POST
    • 客户详情GET
    • 查询客户的阶段、分组、状态、地区、主营产品、来源GET
  • 销售订单
  • 采购订单
  • 产品
  • 回款登记
  • 回款单
  • 付款单
  • 费用单
  • 报价单
  • 供应商
  • 商机
  • 用户
  • 销售出库单
  • 库存
  • 线索
  • 资金
  • 采购入库单
  • 采购退货单
  • 统计分析
  • 示例接口(勿用)
  • 阿里账号信息GET
  • 阿里资金账户信息GET
亮色模式
  1. 客户

客户数据字典

GET/v1/company/fields

字段类型有哪些

field_type
1 单行文本
2 多行文本
3 单选,在该字段选项枚举值在返回值中的ext_info里面,可用于单据新建、编辑该字段传值
4 日期,YYYY-MM-DD
5 数字
6 图片
7 多选,在该字段选项枚举值在返回值中的ext_info里面,可用于单据新建、编辑该字段传值
8 附件
9 关联字段
10 日期时间,YYYY-MM-DD HH:mm:ss
11 公式
12 汇总
13 布尔
17 状态
18 阶段
21 时间范围
22 富文本
23 引用

若发现没有的字段类型可以咨询对接群,或者提客户工单。

请求参数

Query 参数
type
string 
可选

company=客户数据字典,customer=联系人数据字典 默认值: company

示例值:
company
Header 参数
Authorization
string 
必需
示例值:
eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxMWMxMzU5NmRlMGJjYzM1MzRlYTIxMWEyMTE0MTdjODcxZjMzZGVjNjVmMzE1MDcxM2EwMTE5N2I0NGJlODY2NDM0YWFmYjczZmI0ZWIwYiIsImp0aSI6IjdhMjA3NTY5MmViNTc1ZGFlNTAyNmNhMzUwNDljYTFiNTgzNmM4MGQ3OTFhMGQzNzk5NTliMGQxODk4ZjI3YjhmYmM3OWE1NDE2NTQyMzQ1IiwiaWF0IjoxNjc1ODI0MTA5LjQ3NzIyLCJuYmYiOjE2NzU4MjQxMDkuNDc3MjIxLCJleHAiOjE2NzU4NTI5MDkuNDUwNTMxLCJzdWIiOiIiLCJzY29wZXMiOlsicHJvZHVjdCIsImNvbXBhbnkiLCJpbnZvaWNlcyIsImxlYWQiLCJvcHBvcnR1bml0eSIsInVzZXIiXX0.PvaNNsQqk6yBl1dlaEQGCWpkn8EoFzuSdkyv8RpKyV_W91-LLDq4qNpBJPW7ieA_qKV44977GIQghGd9FDjvZucY1IfQwxfpeGIztEC5mcdSItSgsCXNWTP-Pw7FX28n6qIvIfKLmm7r4NrBrYbFsLOwFaJ9v13RNFF6NhvZognYlcveVIT2vwRL48HSZUjzRqPKo93rWbEojXaqGfsc9qLptyZ1IAhJqSh6ZrEVQBe6awa-R7G4AiFiqCMXQfsuON6xWu__F51FyEzk-vr40qvmBY82SuSAGuTkUsVKXDpoZHz8ZQoY9KG822t5WMeziaGq8CW8er6A7LF0IeWUDQ

示例代码

返回响应

成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
code
integer 
必需
message
string 
必需
now
string 
必需
data
array [object {9}] 
必需
id
string  | integer 
字段ID
必需
name
string 
字段名称
必需
base
integer 
必需

是否系统字段,1=系统字段,0=自定义字段

field_type
integer 
字段类型
必需
ext_info
array[string] | null 
必需

选字段额外信息,比如选项等枚举值

require
integer 
必需

是否必填,1=必填,0=非必填

default
string 
默认值
必需
disable_flag
integer 
必需
is_list
integer 
是否明细字段
必需
示例
{
  "code": 200,
  "message": "success",
  "now": "2025-03-04 17:12:05",
  "data": [
    {
      "id": "",
      "name": "来源详情",
      "base": 1,
      "field_type": 7,
      "ext_info": null,
      "require": 0,
      "default": "",
      "disable_flag": 0,
      "is_list": 1
    },
    {
      "id": "origin_list",
      "name": "客户来源",
      "base": 1,
      "field_type": 7,
      "ext_info": null,
      "require": 1,
      "default": "",
      "disable_flag": 0,
      "is_list": 0
    },
    {
      "id": "biz_type",
      "name": "客户类型",
      "base": 1,
      "field_type": 3,
      "ext_info": null,
      "require": 0,
      "default": "",
      "disable_flag": 0,
      "is_list": 0
    },
    {
      "id": "scale_id",
      "name": "规模",
      "base": 1,
      "field_type": 3,
      "ext_info": null,
      "require": 0,
      "default": "",
      "disable_flag": 0,
      "is_list": 0
    },
    {
      "id": "short_name",
      "name": "简称",
      "base": 1,
      "field_type": 1,
      "ext_info": null,
      "require": 0,
      "default": "",
      "disable_flag": 0,
      "is_list": 0
    },
    {
      "id": "cus_tag",
      "name": "客户标签",
      "base": 1,
      "field_type": 7,
      "ext_info": null,
      "require": 0,
      "default": "",
      "disable_flag": 0,
      "is_list": 0
    },
    {
      "id": "trail_status",
      "name": "客户阶段",
      "base": 1,
      "field_type": 3,
      "ext_info": null,
      "require": 0,
      "default": "",
      "disable_flag": 0,
      "is_list": 0
    },
    {
      "id": "homepage",
      "name": "公司网址",
      "base": 1,
      "field_type": 1,
      "ext_info": null,
      "require": 0,
      "default": "",
      "disable_flag": 0,
      "is_list": 0
    },
    {
      "id": "category_ids",
      "name": "主营产品",
      "base": 1,
      "field_type": 7,
      "ext_info": null,
      "require": 0,
      "default": "",
      "disable_flag": 0,
      "is_list": 0
    },
    {
      "id": "product_group_ids",
      "name": "产品分组",
      "base": 1,
      "field_type": 7,
      "ext_info": null,
      "require": 0,
      "default": "",
      "disable_flag": 0,
      "is_list": 0
    },
    {
      "id": "intention_level",
      "name": "采购意向",
      "base": 1,
      "field_type": 3,
      "ext_info": null,
      "require": 0,
      "default": "",
      "disable_flag": 1,
      "is_list": 0
    },
    {
      "id": "annual_procurement",
      "name": "年采购额",
      "base": 1,
      "field_type": 3,
      "ext_info": null,
      "require": 0,
      "default": "",
      "disable_flag": 0,
      "is_list": 0
    },
    {
      "id": "address",
      "name": "详细地址",
      "base": 1,
      "field_type": 2,
      "ext_info": null,
      "require": 0,
      "default": "",
      "disable_flag": 0,
      "is_list": 0
    },
    {
      "id": "name",
      "name": "公司名称",
      "base": 1,
      "field_type": 1,
      "ext_info": null,
      "require": 1,
      "default": "",
      "disable_flag": 0,
      "is_list": 0
    },
    {
      "id": "province",
      "name": "省份",
      "base": 1,
      "field_type": 3,
      "ext_info": null,
      "require": 0,
      "default": "",
      "disable_flag": 0,
      "is_list": 0
    },
    {
      "id": "group_id",
      "name": "客户分组",
      "base": 1,
      "field_type": 3,
      "ext_info": null,
      "require": 0,
      "default": "",
      "disable_flag": 0,
      "is_list": 0
    },
    {
      "id": "serial_id",
      "name": "客户编号",
      "base": 1,
      "field_type": 1,
      "ext_info": null,
      "require": 0,
      "default": "",
      "disable_flag": 0,
      "is_list": 0
    },
    {
      "id": "fax",
      "name": "传真",
      "base": 1,
      "field_type": 1,
      "ext_info": null,
      "require": 0,
      "default": "",
      "disable_flag": 0,
      "is_list": 0
    },
    {
      "id": "tel",
      "name": "座机",
      "base": 1,
      "field_type": 1,
      "ext_info": null,
      "require": 0,
      "default": "",
      "disable_flag": 0,
      "is_list": 0
    },
    {
      "id": "country",
      "name": "国家地区",
      "base": 1,
      "field_type": 3,
      "ext_info": null,
      "require": 0,
      "default": "",
      "disable_flag": 0,
      "is_list": 0
    },
    {
      "id": "city",
      "name": "城市",
      "base": 1,
      "field_type": 3,
      "ext_info": null,
      "require": 0,
      "default": "",
      "disable_flag": 0,
      "is_list": 0
    },
    {
      "id": "timezone",
      "name": "时区",
      "base": 1,
      "field_type": 3,
      "ext_info": null,
      "require": 0,
      "default": "",
      "disable_flag": 0,
      "is_list": 0
    },
    {
      "id": "remark",
      "name": "公司备注",
      "base": 1,
      "field_type": 2,
      "ext_info": null,
      "require": 0,
      "default": "龙琴",
      "disable_flag": 0,
      "is_list": 0
    },
    {
      "id": "image_list",
      "name": "公司logo",
      "base": 1,
      "field_type": 6,
      "ext_info": null,
      "require": 0,
      "default": "",
      "disable_flag": 0,
      "is_list": 0
    },
    {
      "id": "next_follow_up_time",
      "name": "下次日程时间",
      "base": 1,
      "field_type": 10,
      "ext_info": null,
      "require": 0,
      "default": "",
      "disable_flag": 0,
      "is_list": 0
    },
    {
      "id": 5200812401,
      "name": "测试日期",
      "base": 0,
      "field_type": 4,
      "ext_info": null,
      "require": 0,
      "default": "",
      "disable_flag": 0,
      "is_list": 0
    },
    {
      "id": 5200433878,
      "name": "兴趣爱好",
      "base": 0,
      "field_type": 7,
      "ext_info": [
        "游泳",
        "登山"
      ],
      "require": 0,
      "default": "",
      "disable_flag": 0,
      "is_list": 0
    },
    {
      "id": 5196023966,
      "name": "最新报价时间",
      "base": 0,
      "field_type": 4,
      "ext_info": null,
      "require": 0,
      "default": "",
      "disable_flag": 0,
      "is_list": 0
    },
    {
      "id": "5118904304",
      "name": "报价时间",
      "base": 0,
      "field_type": 10,
      "ext_info": null,
      "require": 0,
      "default": "",
      "disable_flag": 0,
      "is_list": 0
    },
    {
      "id": "3082106516",
      "name": "haodeya",
      "base": 0,
      "field_type": 5,
      "ext_info": null,
      "require": 0,
      "default": "",
      "disable_flag": 0,
      "is_list": 0
    },
    {
      "id": "3462856443",
      "name": "公司信息图片类型字段",
      "base": 0,
      "field_type": 6,
      "ext_info": null,
      "require": 0,
      "default": "",
      "disable_flag": 0,
      "is_list": 0
    },
    {
      "id": "3266094846",
      "name": "客户自定义多行文本",
      "base": 0,
      "field_type": 2,
      "ext_info": null,
      "require": 0,
      "default": "22",
      "disable_flag": 0,
      "is_list": 0
    },
    {
      "id": "3215316242",
      "name": "导出日期字段测试",
      "base": 0,
      "field_type": 4,
      "ext_info": null,
      "require": 0,
      "default": "",
      "disable_flag": 1,
      "is_list": 0
    },
    {
      "id": "3043781064",
      "name": "测试公司-tv-多行文本",
      "base": 0,
      "field_type": 2,
      "ext_info": null,
      "require": 0,
      "default": "123",
      "disable_flag": 1,
      "is_list": 0
    },
    {
      "id": "3113323380",
      "name": "Product group radio",
      "base": 0,
      "field_type": 3,
      "ext_info": [
        "单选1",
        "单选2",
        "add one new option"
      ],
      "require": 0,
      "default": "",
      "disable_flag": 0,
      "is_list": 0
    },
    {
      "id": "1887817526",
      "name": "ccccc",
      "base": 0,
      "field_type": 1,
      "ext_info": null,
      "require": 0,
      "default": "",
      "disable_flag": 1,
      "is_list": 0
    },
    {
      "id": "1118472446",
      "name": "OS Field",
      "base": 0,
      "field_type": 1,
      "ext_info": null,
      "require": 0,
      "default": "",
      "disable_flag": 0,
      "is_list": 0
    },
    {
      "id": 3570150046,
      "name": "自定义字段0626下午",
      "base": 0,
      "field_type": 3,
      "ext_info": [
        "自定义字段0626下午1",
        "自定义字段0626下午2"
      ],
      "require": 0,
      "default": "",
      "disable_flag": 0,
      "is_list": 0
    },
    {
      "id": 3568031711,
      "name": "中文字段5",
      "base": 0,
      "field_type": 2,
      "ext_info": null,
      "require": 0,
      "default": "",
      "disable_flag": 0,
      "is_list": 0
    },
    {
      "id": "3043780965",
      "name": "下拉多选",
      "base": 0,
      "field_type": 7,
      "ext_info": [
        "test",
        "苹果",
        "雪梨",
        "kevinAdd",
        "yang",
        "huangzhengbang"
      ],
      "require": 0,
      "default": "",
      "disable_flag": 0,
      "is_list": 0
    },
    {
      "id": "3082106510",
      "name": "测试公司-tv-文本",
      "base": 0,
      "field_type": 1,
      "ext_info": null,
      "require": 0,
      "default": "我是必填文本默认值",
      "disable_flag": 0,
      "is_list": 0
    },
    {
      "id": 3474261902,
      "name": "供应商数量",
      "base": 0,
      "field_type": 5,
      "ext_info": null,
      "require": 0,
      "default": "",
      "disable_flag": 0,
      "is_list": 0
    },
    {
      "id": 3472848096,
      "name": "公司仓库数量",
      "base": 0,
      "field_type": 5,
      "ext_info": null,
      "require": 0,
      "default": "",
      "disable_flag": 0,
      "is_list": 0
    },
    {
      "id": "3307965519",
      "name": "test客户管理",
      "base": 0,
      "field_type": 7,
      "ext_info": [
        "2",
        "3",
        "1"
      ],
      "require": 0,
      "default": "",
      "disable_flag": 0,
      "is_list": 0
    },
    {
      "id": "3082106514",
      "name": "测试公司-日期-tv",
      "base": 0,
      "field_type": 4,
      "ext_info": null,
      "require": 0,
      "default": "",
      "disable_flag": 0,
      "is_list": 0
    },
    {
      "id": "3113338556",
      "name": "产品多行文本",
      "base": 0,
      "field_type": 2,
      "ext_info": null,
      "require": 0,
      "default": "",
      "disable_flag": 1,
      "is_list": 0
    },
    {
      "id": "3137336748",
      "name": "新老客户类型",
      "base": 0,
      "field_type": 7,
      "ext_info": [
        "新客户",
        "老客户"
      ],
      "require": 0,
      "default": "",
      "disable_flag": 1,
      "is_list": 0
    },
    {
      "id": "1106335125",
      "name": "自定义字段-数值",
      "base": 0,
      "field_type": 5,
      "ext_info": null,
      "require": 0,
      "default": "",
      "disable_flag": 1,
      "is_list": 0
    },
    {
      "id": "1118472445",
      "name": "字段名称 - os001",
      "base": 0,
      "field_type": 3,
      "ext_info": null,
      "require": 0,
      "default": "",
      "disable_flag": 1,
      "is_list": 0
    },
    {
      "id": "3117881352",
      "name": "询盘产品-测试工单",
      "base": 0,
      "field_type": 7,
      "ext_info": [
        "洗衣片",
        "吸色片",
        "留香珠"
      ],
      "require": 0,
      "default": "",
      "disable_flag": 1,
      "is_list": 0
    },
    {
      "id": "3082106517",
      "name": "测试公司的下拉多选",
      "base": 0,
      "field_type": 7,
      "ext_info": [
        "Go",
        "I...",
        "Uh...",
        "People",
        "He"
      ],
      "require": 0,
      "default": "",
      "disable_flag": 1,
      "is_list": 0
    },
    {
      "id": "3025700946",
      "name": "客户老编号",
      "base": 0,
      "field_type": 1,
      "ext_info": null,
      "require": 0,
      "default": "我是默认值",
      "disable_flag": 1,
      "is_list": 0
    },
    {
      "id": "3082106518",
      "name": "测试公司-tv-日期时间",
      "base": 0,
      "field_type": 10,
      "ext_info": null,
      "require": 0,
      "default": "",
      "disable_flag": 1,
      "is_list": 0
    }
  ]
}
最后修改时间: 1 天前