Follow Up Boss (CLI)
CLI for interacting with the Follow Up Boss API.
Setup
- 1. Get API Key: Follow Up Boss → Admin → API → Create API Key
- 2. Set Environment Variable:
CODEBLOCK0
CLI Usage
CODEBLOCK1
Commands
| Command | Description |
|---|
| INLINECODE0 | Current user info |
| INLINECODE1 |
List/search people |
|
person <id> | Get person details |
|
people create <json> | Create person via /events (triggers automations) |
|
people update <id> <json> | Update a person |
|
notes <personId> | Get notes for a person |
|
notes create <json> | Create a note |
|
tasks [query] | List tasks |
|
tasks create <json> | Create a task |
|
tasks complete <id> | Complete a task |
|
events [query] | List events |
|
events create <json> | Create event (for lead intake) |
|
pipelines | Get pipelines |
|
deals [query] | List deals |
|
deals create <json> | Create a deal |
|
textmessages <personId> | Get text messages for a person |
|
textmessages create <json> | Log a text (NOT sent - recorded only!) |
|
emails <personId> | Get emails for a person |
|
emails create <json> | Log an email (NOT sent - recorded only!) |
|
calls <personId> | Get calls for a person |
|
calls create <json> | Log a call |
|
webhooks | List webhooks |
|
webhooks create <json> | Create webhook |
|
webhooks delete <id> | Delete webhook |
|
sources | Get lead sources |
|
users | Get users/agents |
|
search <query> | Global search |
Examples
CODEBLOCK2
Important Notes
- - Text/Email Logging: The API can log texts and emails but cannot actually send them. Use FUB's built-in texting or integrations like SendHub for sending.
- Rate Limits: GET /events: 20 req/10 sec, All else: 250 req/10 sec
Follow Up Boss (CLI)
用于与 Follow Up Boss API 交互的命令行工具。
设置
- 1. 获取 API 密钥：Follow Up Boss → 管理 → API → 创建 API 密钥
- 2. 设置环境变量：
bash
export FUB
APIKEY=fka_xxxxxxxxxxxx
CLI 使用
bash
node fub.js <命令> [选项]
命令
列出/搜索联系人 |
| person
| 获取联系人详情 |
| people create | 通过 /events 创建联系人（触发自动化） |
| people update | 更新联系人 |
| notes <联系人ID> | 获取联系人的备注 |
| notes create | 创建备注 |
| tasks [查询] | 列出任务 |
| tasks create | 创建任务 |
| tasks complete | 完成任务 |
| events [查询] | 列出事件 |
| events create | 创建事件（用于线索录入） |
| pipelines | 获取管道 |
| deals [查询] | 列出交易 |
| deals create | 创建交易 |
| textmessages <联系人ID> | 获取联系人的短信 |
| textmessages create | 记录短信（不发送 - 仅记录！） |
| emails <联系人ID> | 获取联系人的邮件 |
| emails create | 记录邮件（不发送 - 仅记录！） |
| calls <联系人ID> | 获取联系人的通话 |
| calls create | 记录通话 |
| webhooks | 列出 Webhook |
| webhooks create | 创建 Webhook |
| webhooks delete | 删除 Webhook |
| sources | 获取线索来源 |
| users | 获取用户/经纪人 |
| search <查询> | 全局搜索 |
示例
bash
列出联系人
node fub.js people limit=10
获取联系人
node fub.js person 123
创建线索（触发自动化！）
node fub.js events create {source:网站,system:{name:张三,email:zhangsan@test.com,phone:5551234567}}
添加备注
node fub.js notes create {personId:123,body:已致电 - 留言}
创建任务
node fub.js tasks create {personId:123,body:跟进,dueDate:2026-02-20}
完成任务
node fub.js tasks complete 456
记录短信（不发送 - 仅记录！）
node fub.js textmessages create {personId:123,body:你好！,direction:outbound}
记录通话
node fub.js calls create {personId:123,direction:outbound,outcome:voicemail}
搜索
node fub.js search 张三
重要说明
- - 短信/邮件记录：API 可以记录短信和邮件，但无法实际发送。如需发送，请使用 FUB 内置的短信功能或 SendHub 等集成服务。
- 速率限制：GET /events：20 次请求/10 秒，其他所有操作：250 次请求/10 秒
