follow-up-boss

用于与 Follow Up Boss API 交互的 CLI。管理人员、笔记、任务、事件、交易、网络挂钩等。

# 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**:
```bash
export FUB_API_KEY="fka_xxxxxxxxxxxx"
```

## CLI Usage

```bash
node fub.js <command> [options]
```

## Commands

| Command | Description |
|---------|-------------|
| `me` | Current user info |
| `people [query]` | 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

```bash
# List people
node fub.js people "limit=10"

# Get person
node fub.js person 123

# Create a lead (triggers automations!)
node fub.js events create '{"source":"Website","system":{"name":"John Doe","email":"john@test.com","phone":"5551234567"}}'

# Add a note
node fub.js notes create '{"personId":123,"body":"Called - left voicemail"}'

# Create task
node fub.js tasks create '{"personId":123,"body":"Follow up","dueDate":"2026-02-20"}'

# Complete task
node fub.js tasks complete 456

# Log a text (NOT sent - recorded!)
node fub.js textmessages create '{"personId":123,"body":"Hey!","direction":"outbound"}'

# Log a call
node fub.js calls create '{"personId":123,"direction":"outbound","outcome":"voicemail"}'

# Search
node fub.js search "john"
```

## 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 交互的 CLI。

## 设置

1. **获取 API 密钥**：Follow Up Boss → Admin → API → Create API Key

2. **设置环境变量**：
```bash
export FUB_API_KEY="fka_xxxxxxxxxxxx"
```

## CLI 用法

```bash
node fub.js <command> [options]
```

## 命令

| 命令 | 描述 |
|---------|-------------|
| `me` | 当前用户信息 |
| `people [query]` | 列出/搜索人员 |
| `person <id>` | 获取人员详情 |
| `people create <json>` | 通过 /events 创建人员（触发自动化） |
| `people update <id> <json>` | 更新人员 |
| `notes <personId>` | 获取某人的笔记 |
| `notes create <json>` | 创建笔记 |
| `tasks [query]` | 列出任务 |
| `tasks create <json>` | 创建任务 |
| `tasks complete <id>` | 完成任务 |
| `events [query]` | 列出事件 |
| `events create <json>` | 创建事件（用于线索接入） |
| `pipelines` | 获取管道 |
| `deals [query]` | 列出交易 |
| `deals create <json>` | 创建交易 |
| `textmessages <personId>` | 获取某人的短信 |
| `textmessages create <json>` | 记录一条短信（不发送 - 仅记录！） |
| `emails <personId>` | 获取某人的邮件 |
| `emails create <json>` | 记录一封邮件（不发送 - 仅记录！） |
| `calls <personId>` | 获取某人的通话 |
| `calls create <json>` | 记录一次通话 |
| `webhooks` | 列出网络挂钩 |
| `webhooks create <json>` | 创建网络挂钩 |
| `webhooks delete <id>` | 删除网络挂钩 |
| `sources` | 获取线索来源 |
| `users` | 获取用户/经纪人 |
| `search <query>` | 全局搜索 |

## 示例

```bash
# List people
node fub.js people "limit=10"

# Get person
node fub.js person 123

# Create a lead (triggers automations!)
node fub.js events create '{"source":"Website","system":{"name":"John Doe","email":"john@test.com","phone":"5551234567"}}'

# Add a note
node fub.js notes create '{"personId":123,"body":"Called - left voicemail"}'

# Create task
node fub.js tasks create '{"personId":123,"body":"Follow up","dueDate":"2026-02-20"}'

# Complete task
node fub.js tasks complete 456

# Log a text (NOT sent - recorded!)
node fub.js textmessages create '{"personId":123,"body":"Hey!","direction":"outbound"}'

# Log a call
node fub.js calls create '{"personId":123,"direction":"outbound","outcome":"voicemail"}'

# Search
node fub.js search "john"
```

## 重要说明

- **短信/邮件记录**：API 可以记录短信和邮件，但无法实际发送它们。请使用 FUB 内置的短信功能或诸如 SendHub 之类的集成来发送。
- **速率限制**：GET /events：20 次请求/10 秒，其他所有：250 次请求/10 秒