探马OpenAPI

查询企业字段

POST

/api/v3/corp-profile-fields

请求参数

Header 参数

appId

string

应用 appId

必需

默认值:

timestamp

string

请求时间戳

必需

默认值:

sign

string

请求消息签名值

必需

默认值:

appKey

string

应用 appKey

可选

默认值:

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/v3/corp-profile-fields' \
--header 'appId;' \
--header 'timestamp;' \
--header 'sign;' \
--header 'appKey: {{appKey}}'

返回响应

🟢200成功

application/json

Body

code

integer

成功请求，返回0

必需

message

string

必需

成功请求，返回 success

data

array [object {11}]

返回数据值

可选

integer

字段ID

必需

name

string

字段名称

必需

type

integer

必需

字段类型。1表示单行文本，2表示单选，3表示日期，4表示数值，5表示多行文本，6表示多选，7表示日期时间，8电话

importRequired

boolean

必需

是否必填配置 true:开启，false：不开启

personal

boolean

必需

个人客户字段 true::开启，false：不开启

corporate

boolean

必需

企业客户字段 true:开启，false：不开启

clue

boolean

必需

是否可用于线索&待分配客户

contact

boolean

必需

联系人字段 true:开启，false：不开启

maxUnicode

integer

可选

如果是文本内容，允许输入最大字符数

scale

integer

可选

如果是数字，小数精度

enable

boolean

是否开启

必需

示例

{
  "code": 0,
  "message": "string",
  "data": [
    {
      "id": 0,
      "name": "string",
      "type": 0,
      "importRequired": true,
      "personal": true,
      "corporate": true,
      "clue": true,
      "contact": true,
      "maxUnicode": 0,
      "scale": 0,
      "enable": true
    }
  ]
}

🟢200失败

获取员工id

查询客户字段