Leadbase Open API
API reference
Leadbaseの営業リード検索、アタックリスト作成、CSV出力を外部システムから実行できます。APIキーはマイページでユーザーごとに発行します。
Authentication
すべてのOpen APIはBearerトークン認証です。APIキーは一度だけ表示され、利用量は画面操作と同じ月間利用量に合算されます。
Header
Authorization: Bearer lb_live_xxxGET
/v1/leads/search
リードを検索・絞り込みします。結果はJSONで返ります。
| Parameter | Description |
|---|---|
| keyword | 企業名・キーワード |
| industry | 業種 |
| region | 地域 |
| email / form / phone | 連絡手段の有無 |
| highReady | 営業準備度が高いリード |
| minLeadScore | 最低リードスコア |
| limit / page | ページング |
GET
/v1/leads/export.csv
検索条件に一致するリードをCSVで出力します。月間出力上限は契約プランの利用量と共通です。
Lists
GET /v1/lists
POST /v1/lists
GET /v1/lists/:id
GET /v1/lists/:id/export.csv
DELETE /v1/lists/:id
法人番号の配列、または検索条件からアタックリストを作成できます。
GET
/v1/usage
当月の利用量、CSV出力上限、プラン情報を確認できます。
Errors
認証失敗は401、権限や上限超過は403、対象なしは404で返ります。