联系人API提供了一个简单的界面来管理您的联系人。联系人代表个人(如Mark Johnson)或组织(如谷歌)。每个联系人有两个状态字段:customer_status而且prospect_status.它们描述了联系人与您的业务的关系。

联系人类型:

  • 定期联系-你认识的人或组织,但你还没有与其建立业务关系。
  • 当前的前景-你积极推销给的人或组织。
  • 失去了前景-你过去曾试图与之销售,但未能完成交易的个人或组织。失去的潜在客户以前从来都不是客户。
  • 当前客户-目前从您的企业购买商品或服务的个人或组织。
  • 过去的客户-以前从您的企业购买商品或服务,但不再这样做的个人或组织。

您可以为联系人分配任意数量的标记和自定义字段。标签不需要已经存在才能被分配;如果需要,将创建它们。

这个API允许你创建、删除和更新你的联系人。您可以检索单个客户,也可以检索所有客户的列表。

JSON格式

的名字 类型 只读 描述
id 数量 真正的 联系人的唯一标识符。
creator_id 数量 真正的 创建联系人的用户的唯一标识符。
owner_id 数量 联系人当前分配给的用户的唯一标识符。
is_organization 布尔 指示此联系人是指组织还是个人。该值可以设置只有在创建过程中不能以后再改。默认值为
contact_id 数量 联系人所属组织的唯一标识符。只有当联系人是个人时,才会设置该字段。
parent_organization_id 数量 组织联系人的唯一标识符,该组织的父组织联系人。只有当联系人是组织并且有父联系人时,才会设置该字段。
的名字 字符串 联系人名称。仅当联系人为组织时需要填写。
first_name 字符串 联系人的名字。
last_name 字符串 联系人的姓。仅当联系人是个人时才需要。
customer_status 字符串 联系人的客户状态。可能的值:没有一个当前的过去的
prospect_status 字符串 联系人的前景状态。可能的值:没有一个当前的失去了
标题 字符串 联系人的职位名称。
描述 字符串 联系人的描述。
行业 字符串 联系人的行业。
网站 字符串 联系人的网址。
电子邮件 字符串 联系人的电子邮件地址。
电话 字符串 联系人的电话号码。
移动 字符串 联系人的手机号码。
传真 字符串 联系人的传真号码。
推特 字符串 联系人的Twitter账号。
脸谱网 字符串 联系人的Facebook昵称。
linkedin 字符串 联系人的Linkedin昵称。
skype 字符串 联系人的Skype昵称。
地址 字符串 联系人的地址。有关的更多信息地址对象看地址
billing_address 字符串 客户的账单地址。仅适用于以下任何一种情况customer_statusprospect_status不同于没有一个.有关地址对象的更多信息,请参见地址
shipping_address 字符串 客户的送货地址。仅适用于以下任何一种情况customer_statusprospect_status不同于没有一个.有关地址对象的更多信息,请参见地址
标签 数组 联系人的标记数组。详情见标签
custom_fields 对象 自定义字段是附加到联系人的键值对。详情见自定义字段
created_at 字符串 真正的 以UTC (ISO8601格式)创建联系人的日期和时间。
updated_at 字符串 真正的 联系人上一次更新的UTC (ISO8601格式)日期和时间。

检索所有联系人

             
得到/v2/联系人

根据提供的参数返回用户可用的所有联系人。

参数

的名字 要求 类型 描述
页面 数量 查询 开始的页码。页编号以1为基础,省略页面参数将返回第一页。
per_page 数量 查询 每页要返回的记录数。默认限制为25可以返回的最大数量是One hundred.
sort_by 字符串 查询 一个可以排序的领域。您也可以根据可过滤的自定义字段进行排序。示例:要按名为“external_id”的自定义字段排序,请使用? sort_by = custom_fields: external_id.支持自定义字段类型:数字,单行文本,下拉,多选择。默认顺序为升序。若要将排序顺序改为降序,请添加: desc去野外。例子:sort_by = last_name: desc.取值:id, name, first_name, last_name, email, custom_fields, updated_at, created_at
id 字符串 查询 您希望在请求中返回的联系人的id的逗号分隔列表。
creator_id 数量 查询 用户ID。返回该用户创建的所有联系人。
owner_id 数量 查询 用户ID。返回该用户拥有的所有联系人。
is_organization 布尔 查询 指示此联系人是指组织还是个人。
contact_id 数量 查询 联系人所属组织的唯一标识符。
的名字 字符串 查询 联系人名称。
first_name 字符串 查询 联系人的名字。
last_name 字符串 查询 联系人的姓。
电子邮件 字符串 查询 联系人的邮箱地址。
电话 字符串 查询 联系人的电话号码。
移动 字符串 查询 联系人的手机号码。
customer_status 字符串 查询 联系人的客户状态。可能的值:没有一个当前的过去的
prospect_status 字符串 查询 联系人的前景状态。可能的值:没有一个当前的失去了
地址(城市) 字符串 查询 城市的名字。
地址(postal_code) 字符串 查询 邮编或同等邮编
地址(国家) 字符串 查询 国家的名字。
地址(状态) 字符串 查询 国家/地区名称。
billing_address 地址 查询 如果联系人既不是客户也不是潜在客户(见customer_status而且prospect_status详情请填写)。
shipping_address 地址 查询 如果联系人既不是客户也不是潜在客户(见customer_status而且prospect_status详情请填写)。
custom_fields 字符串 查询 可过滤的自定义字段。示例:使用以下方法查找具有自定义字段“external_id”且值为“SKU01”的联系人:? custom_fields [external_id] = SKU01.自定义字段必须定义并具有滤过性的分配给他们的财产。支持自定义字段类型:数字,单行文本,下拉,多选择。
包容 布尔 查询 指示应该如何组合过滤器。真正的value,默认值,使用AND逻辑。value使用OR逻辑组合过滤器。

允许

  • 代理

使用旋度

             
旋度-v -X GET https://api.getbase.com/v2/contacts- h“接受:application / json”- h“授权:持票人ACCESS_TOKEN美元

示例响应

             
HTTP /1.1200好吧内容类型application / json;charset = utf8内容语言{“项目”{“数据”{“id”1“creator_id”1“owner_id”1“is_organization”真正的“contact_id”“parent_organization_id”2“名称”“设计服务公司”“first_name”“last_name”“customer_status”“没有”“prospect_status”“没有”“标题”“描述”“行业”“设计服务”“网站”“http://www.designservice.com”“电子邮件”“电话”“移动”“传真”“+ 44-208-1234567”“推特”“facebook”“linkedin”“skype”“地址”{“line1”“史密斯街2726号”“城市”“海恩尼斯”“postal_code”“02601”“状态”“马”“国家”“我们”“billing_address”“shipping_address”“标签”“重要”]“custom_fields”{“known_via”“汤姆”“created_at”“2014 - 08 - 27 - t16:32:56z”“updated_at”“2014 - 08 - 27 - t16:32:56z”“元”{“类型”“接触”{“数据”{“id”2“creator_id”1“owner_id”1“is_organization”“contact_id”1“parent_organization_id”“名称”“Mark Johnson”“first_name”“马克”“last_name”“约翰逊”“customer_status”“没有”“prospect_status”“没有”“标题”“首席执行官”“描述”"我是通过汤姆认识他的"“行业”“设计服务”“网站”“http://www.designservice.com”“电子邮件”(电子邮件保护)“电话”“508-778-6516”“移动”“508-778-6516”“传真”“+ 44-208-1234567”“推特”“mjohnson”“facebook”“mjohnson”“linkedin”“mjohnson”“skype”“mjohnson”“地址”{“line1”“史密斯街2726号”“城市”“海恩尼斯”“postal_code”“02601”“状态”“马”“国家”“我们”“billing_address”“shipping_address”“标签”“重要”]“custom_fields”{“known_via”“汤姆”“created_at”“2014 - 08 - 27 - t16:32:56z”“updated_at”“2014 - 08 - 27 - t16:32:56z”“元”{“类型”“接触”]“元”{“类型”“收集”“数”2“链接”{“自我”“http://api.getbase.com/v2/contacts”

创建联系人

创建一个新联系人。联系人可以代表个人或组织。

参数

的名字 要求 类型 描述
的名字 真正的 字符串 身体 仅当联系人为组织时需要填写。is_organization设置为真正的
first_name 字符串 身体 只有当联系人是个人时,才会设置该字段。is_organization设置为
last_name 真正的 字符串 身体 仅当联系人是个人时才需要。is_organization设置为
owner_id 数量 身体 默认为创建联系人的用户的唯一标识符。
is_organization 布尔 身体 该值可以设置只有在创建过程中不能以后再改。
contact_id 数量 身体 只有当联系人是个人时,才会设置该字段。is_organization设置为
parent_organization_id 数量 身体 应设置为此组织的父级的联系人的唯一标识符。引用的联系人也必须是一个组织。可以设置只有有关机构联络(is_organization设置为真正的
customer_status 字符串 身体 如。没有一个
prospect_status 字符串 身体 如。当前的
标题 字符串 身体 如。首席执行官
描述 字符串 身体 如。我是通过汤姆认识他的
行业 字符串 身体 如。设计服务
网站 字符串 身体 如。www.designservices.com
电子邮件 字符串 身体 如。(电子邮件保护)
电话 字符串 身体 如。508-778-6516
移动 字符串 身体 如。508-778-6516
传真 字符串 身体 如。+ 44-208-1234567
推特 字符串 身体 如。mjohnson
脸谱网 字符串 身体 如。mjohnson
linkedin 字符串 身体 如。mjohnson
skype 字符串 身体 如。mjohnson
地址 地址 身体
billing_address 地址 身体 如果联系人既不是客户也不是潜在客户(见customer_status而且prospect_status详情请填写)。
shipping_address 地址 身体 如果联系人既不是客户也不是潜在客户(见customer_status而且prospect_status详情请填写)。
标签 数组 身体 为了修改它,您需要提供整个集合。
custom_fields 对象 身体 如。{“known_via”:“汤姆”}

允许

  • 代理

使用旋度

             
旋度-v -X POST https://api.getbase.com/v2/contacts- h“接受:application / json”- h“application / json内容类型:- h“授权:持票人ACCESS_TOKEN美元- d”{"数据":{“contact_id”:1、“姓名”:“马克·约翰逊”,“first_name”:“马克”,“last_name”:“约翰逊”,“标题”:“首席执行官”,"description": "我是通过汤姆认识他的"“工业”:“设计服务”,“网站”:“http://www.designservice.com”,“电子邮件”:“(电子邮件保护)”,“电话”:“508-778-6516”,“移动”:“508-778-6516”,“传真”:“+ 44-208-1234567”,“twitter”:“mjohnson”,“facebook”:“mjohnson”,“linkedin”:“mjohnson”,“skype”:“mjohnson”,"地址":{“1号线”:史密斯街2726号,“城市”:“海恩尼斯”,“postal_code”:“02601”,“状态”:“妈”,“国家”:“我们”},“标签”:[“承包商”,“早期采用者”)," custom_fields ": {“referral_website”:“http://www.example.com”}'

示例响应

             
HTTP /1.1200好吧内容类型application / json;charset = utf8内容语言{“数据”{“id”2“creator_id”1“owner_id”1“is_organization”“contact_id”1“parent_organization_id”“名称”“Mark Johnson”“first_name”“马克”“last_name”“约翰逊”“customer_status”“没有”“prospect_status”“没有”“标题”“首席执行官”“描述”"我是通过汤姆认识他的"“行业”“设计服务”“网站”“http://www.designservice.com”“电子邮件”(电子邮件保护)“电话”“508-778-6516”“移动”“508-778-6516”“传真”“+ 44-208-1234567”“推特”“mjohnson”“facebook”“mjohnson”“linkedin”“mjohnson”“skype”“mjohnson”“地址”{“line1”“史密斯街2726号”“城市”“海恩尼斯”“postal_code”“02601”“状态”“马”“国家”“我们”“billing_address”“shipping_address”“created_at”“2014 - 08 - 27 - t16:32:56z”“updated_at”“2014 - 08 - 27 - t16:32:56z”“元”{“类型”“接触”

检索单个联系人

             
得到/v2/联系人/id

根据所提供的唯一联系人ID,返回用户可用的单个联系人。如果指定的联系人不存在,请求将返回一个错误。

参数

的名字 要求 类型 描述
id 真正的 数量 查询 联系人的唯一标识符。

允许

  • 代理

使用旋度

             
旋度-v -X GET https://api.getbase.com/v2/contacts/2- h“接受:application / json”- h“授权:持票人ACCESS_TOKEN美元

示例响应

             
HTTP /1.1200好吧内容类型application / json;charset = utf8内容语言{“数据”{“id”2“creator_id”1“owner_id”1“is_organization”“contact_id”1“parent_organization_id”“名称”“Mark Johnson”“first_name”“马克”“last_name”“约翰逊”“customer_status”“没有”“prospect_status”“没有”“标题”“首席执行官”“描述”"我是通过汤姆认识他的"“行业”“设计服务”“网站”“http://www.designservice.com”“电子邮件”(电子邮件保护)“电话”“508-778-6516”“移动”“508-778-6516”“传真”“+ 44-208-1234567”“推特”“mjohnson”“facebook”“mjohnson”“linkedin”“mjohnson”“skype”“mjohnson”“地址”{“line1”“史密斯街2726号”“城市”“海恩尼斯”“postal_code”“02601”“状态”“马”“国家”“我们”“billing_address”“shipping_address”“created_at”“2014 - 08 - 27 - t16:32:56z”“updated_at”“2014 - 08 - 27 - t16:32:56z”“元”{“类型”“接触”

更新联系人

             
/v2/联系人/id

更新联系人信息。如果指定的联系人不存在,请求将返回一个错误。

请注意更新联系人标签时,需要提供所有标签。任何缺失的标签将从联系人的标签中删除。

参数

的名字 要求 类型 描述
id 真正的 数量 查询 联系人的唯一标识符。
的名字 字符串 身体 仅当联系人为组织时,该字段才会设置。is_organization设置为真正的
first_name 字符串 身体 只有当联系人是个人时,才会设置该字段。is_organization设置为
last_name 字符串 身体 只有当联系人是个人时,才会设置该字段。is_organization设置为
contact_id 数量 身体 只有当联系人是个人时,才会设置该字段。is_organization设置为
parent_organization_id 数量 身体 应设置为此组织的父级的联系人的唯一标识符。将此设置为将清除现有的父母关系。引用的联系人也必须是一个组织。可以设置只有有关机构联络(is_organization设置为真正的
owner_id 数量 身体 如。1
customer_status 字符串 身体 如。没有一个
prospect_status 字符串 身体 如。当前的
标题 字符串 身体 如。首席执行官
描述 字符串 身体 如。我是通过汤姆认识他的
行业 字符串 身体 如。设计服务
网站 字符串 身体 如。www.designservices.com
电子邮件 字符串 身体 如。(电子邮件保护)
电话 字符串 身体 如。508-778-6516
移动 字符串 身体 如。508-778-6516
传真 字符串 身体 如。+ 44-208-1234567
推特 字符串 身体 如。mjohnson
脸谱网 字符串 身体 如。mjohnson
linkedin 字符串 身体 如。mjohnson
skype 字符串 身体 如。mjohnson
地址 地址 身体
billing_address 地址 身体 如果联系人是客户或潜在客户,可以更新(看到了吗customer_status而且prospect_status详情请填写)。
shipping_address 地址 身体 如果联系人是客户或潜在客户,可以更新(看到了吗customer_status而且prospect_status详情请填写)。
标签 数组 身体 为了修改它,您需要提供整个集合。
custom_fields 对象 身体 如。”{known_via”:“汤姆”}

允许

  • 代理

使用旋度

             
旋度-v -X PUT https://api.getbase.com/v2/contacts/2- h“接受:application / json”- h“application / json内容类型:- h“授权:持票人ACCESS_TOKEN美元- d”{"数据":{“customer_status”:“当前”,“标签”:[“承包商”,“早期采用者”)," custom_fields ": {“referral_website”:“http://www.example.com”}'

示例响应

             
HTTP /1.1200好吧内容类型application / json;charset = utf8内容语言{“数据”{“id”2“creator_id”1“owner_id”1“is_organization”“contact_id”1“parent_organization_id”“名称”“Mark Johnson”“first_name”“马克”“last_name”“约翰逊”“customer_status”“当前”“prospect_status”“没有”“标题”“首席执行官”“描述”"我是通过汤姆认识他的"“行业”“设计服务”“网站”“http://www.designservice.com”“电子邮件”(电子邮件保护)“电话”“508-778-6516”“移动”“508-778-6516”“传真”“+ 44-208-1234567”“推特”“mjohnson”“facebook”“mjohnson”“linkedin”“mjohnson”“skype”“mjohnson”“地址”{“line1”“史密斯街2726号”“城市”“海恩尼斯”“postal_code”“02601”“状态”“马”“国家”“我们”“billing_address”{“line1”“史密斯街2726号”“城市”“海恩尼斯”“postal_code”“02601”“状态”“马”“国家”“我们”“shipping_address”{“line1”“城市”“postal_code”“状态”“国家”“标签”“承包商”“早期采用者”]“custom_fields”{“referral_website”“http://www.example.com”“created_at”“2014 - 08 - 27 - t16:32:56z”“updated_at”“2014 - 08 - 27 - t16:32:56z”“元”{“类型”“接触”

删除联系人

             
删除/v2/联系人/id

删除已有联系人。如果指定的联系人不存在,请求将返回一个错误。该操作无法恢复。

参数

的名字 要求 类型 描述
id 真正的 数量 查询 联系人的唯一标识符。

允许

  • 代理

使用旋度

             
旋度-v -X DELETE https://api.getbase.com/v2/contacts/1- h“授权:持票人ACCESS_TOKEN美元

示例响应

             
HTTP/1.1204没有内容

上传一个联系人

             
帖子/v2/联系人/插入

根据筛选器或一组筛选器的值创建新联系人或更新现有联系人。至少需要一个筛选器—查询参数。如果没有参数,请求将返回一个错误。

行为:

  1. 如果多个联系人匹配一组筛选器,请求将返回错误- 409。
  2. 如果单个联系人匹配,则更新现有联系人
  3. 如果不匹配,则创建一个新联系人

请注意使用Upsert API,而不是Create或Update,以避免创建不必要的重复记录。如果您希望Sell携带外部系统id(存储为自定义字段),也非常有用。

参数

的名字 要求 类型 描述
creator_id 数量 身体 用户ID。返回该用户创建的所有联系人。
owner_id 数量 身体 用户ID。返回该用户拥有的所有联系人。
is_organization 布尔 身体 指示此联系人是指组织还是个人。
contact_id 数量 身体 联系人所属组织的唯一标识符。
parent_organization_id 数量 身体 应设置为此组织的父级的联系人的唯一标识符。将此设置为将清除现有的父母关系。引用的联系人也必须是一个组织。可以设置只有有关机构联络(is_organization设置为真正的
的名字 字符串 身体 联系人名称。
first_name 字符串 身体 联系人的名字。
last_name 字符串 身体 联系人的姓。
电子邮件 字符串 身体 联系人的邮箱地址。
电话 字符串 身体 联系人的电话号码。
移动 字符串 身体 联系人的手机号码。
customer_status 字符串 身体 联系人的客户状态。可能的值:没有一个当前的过去的
prospect_status 字符串 身体 联系人的前景状态。可能的值:没有一个当前的失去了
地址(城市) 字符串 身体 城市的名字。
地址(postal_code) 字符串 身体 邮编或同等邮编
地址(国家) 字符串 身体 国家的名字。
billing_address 地址 身体 如果联系人是客户或潜在客户,可以更新(看到了吗customer_status而且prospect_status详情请填写)。
shipping_address 地址 身体 如果联系人是客户或潜在客户,可以更新(看到了吗customer_status而且prospect_status详情请填写)。
custom_fields 字符串 身体 可过滤的自定义字段。示例:要对一个名为“external_id”且值为“SKU01”的自定义字段的联系人执行upsert,使用如下方法:? custom_fields [external_id] = SKU01.自定义字段必须定义并具有滤过性的分配给他们的财产。支持自定义字段类型:数字,单行文本,下拉,多选择。
包容 布尔 身体 指示应该如何组合过滤器。真正的value,默认值,使用AND逻辑。value使用OR逻辑组合过滤器。

允许

  • 代理

使用旋度

             
旋度-v -X POST https://api.getbase.com/v2/contacts/upsert?custom_fieldsexternal_id]SKU01- h“接受:application / json”- h“application / json内容类型:- h“授权:持票人ACCESS_TOKEN美元- d”{"数据":{"地址":{“第一行”:“橡树巷494号”}," custom_fields ": {:“external_id SKU01”}'

示例响应

             
HTTP /1.1200好吧内容类型application / json;charset = utf8内容语言{“数据”{“id”2“creator_id”1“owner_id”1“is_organization”“contact_id”1“parent_organization_id”“名称”“Mark Johnson”“first_name”“马克”“last_name”“约翰逊”“customer_status”“没有”“prospect_status”“没有”“标题”“首席执行官”“描述”"我是通过汤姆认识他的"“行业”“设计服务”“网站”“http://www.designservice.com”“电子邮件”(电子邮件保护)“电话”“508-778-6516”“移动”“508-778-6516”“传真”“+ 44-208-1234567”“推特”“mjohnson”“facebook”“mjohnson”“linkedin”“mjohnson”“skype”“mjohnson”“地址”{“line1”“橡树巷494号”“城市”“海恩尼斯”“postal_code”“02601”“状态”“马”“国家”“我们”“billing_address”“shipping_address”“标签”“承包商”“早期采用者”]“custom_fields”{“external_id”“SKU01”“referral_website”“http://www.example.com”“created_at”“2015 - 07 - 16 - t17:14:16z”“updated_at”“2014 - 08 - 27 - t16:32:56z”“元”{“类型”“接触”