メインコンテンツへ
BlueAI
ホーム/CRM(顧客管理)/概要

CRM リファレンス

顧客管理・案件管理・活動履歴を扱う CRM ドメインの API

|
案件(Deals)

案件の作成・更新・ステージ管理・活動履歴の取得を行います。

  • GET/api/v1/crm/deals— 案件一覧を取得
  • POST/api/v1/crm/deals— 案件を作成
  • GET/api/v1/crm/deals/{id}— 案件詳細を取得
  • PATCH/api/v1/crm/deals/{id}— 案件を更新
  • DELETE/api/v1/crm/deals/{id}— 案件を削除
  • POST/api/v1/crm/deals/{id}/stage— 案件のステージを更新
  • GET/api/v1/crm/deals/{id}/activities— 案件の活動履歴を取得
会社(Companies)

取引先企業の登録・管理を行います。

  • GET/api/v1/crm/companies— 会社一覧を取得
  • POST/api/v1/crm/companies— 会社を作成
  • GET/api/v1/crm/companies/{id}— 会社詳細を取得
  • PATCH/api/v1/crm/companies/{id}— 会社を更新
  • DELETE/api/v1/crm/companies/{id}— 会社を削除
連絡先(Contacts)

取引先の担当者情報を管理します。

  • GET/api/v1/crm/contacts— 連絡先一覧を取得
  • GET/api/v1/crm/contacts/{id}— 連絡先詳細を取得
  • POST/api/v1/crm/contacts— 連絡先を作成
  • PATCH/api/v1/crm/contacts/{id}— 連絡先を更新
  • DELETE/api/v1/crm/contacts/{id}— 連絡先を削除
活動(Activities)

案件や連絡先に紐づく活動(メモ・電話・メール等)を記録します。

  • GET/api/v1/crm/activities— 活動一覧を取得
  • POST/api/v1/crm/activities— 活動を作成
  • PATCH/api/v1/crm/activities/{id}— 活動を更新
  • DELETE/api/v1/crm/activities/{id}— 活動を削除
パイプライン(Pipelines)

営業パイプラインの定義・ステージカスタマイズを行います。複数パイプライン(営業・パートナー等)に対応しています。

  • GET/api/v1/crm/pipelines— パイプライン一覧を取得
  • POST/api/v1/crm/pipelines— パイプラインを作成
  • GET/api/v1/crm/pipelines/{id}— パイプラインを取得
  • PATCH/api/v1/crm/pipelines/{id}— パイプラインを更新
  • DELETE/api/v1/crm/pipelines/{id}— パイプラインを削除
タグ(Tags)

案件・会社・連絡先に付与するタグの管理と、タグによるリソースの絞り込みを行います。

  • GET/api/v1/crm/tags— タグ一覧を取得
  • POST/api/v1/crm/tags— タグを作成
  • PATCH/api/v1/crm/tags/{id}— タグを更新
  • DELETE/api/v1/crm/tags/{id}— タグを削除
  • POST/api/v1/crm/tag-assignments— リソースにタグを付与
  • DELETE/api/v1/crm/tag-assignments/{tag_id}— タグを解除
カスタムフィールド(Custom Fields)

案件・会社・連絡先にユーザー定義のフィールドを追加します。テキスト・数値・日付・選択肢などの型をサポートします。

  • GET/api/v1/crm/custom-fields— カスタムフィールド定義一覧を取得
  • POST/api/v1/crm/custom-fields— カスタムフィールドを定義
  • PATCH/api/v1/crm/custom-fields/{id}— カスタムフィールド定義を更新
  • DELETE/api/v1/crm/custom-fields/{id}— カスタムフィールド定義を削除
レポート(Reports)

パイプライン別の受注見込み集計、売上予測、ステージ別分布などの営業レポートを取得します。

  • GET/api/v1/crm/reports/pipeline-summary— パイプラインサマリーを取得
  • GET/api/v1/crm/reports/forecast— 売上予測を取得
  • GET/api/v1/crm/reports/owner-performance— 担当者別実績を取得
一括操作(Bulk Operations)

案件・連絡先の一括ステージ変更、一括削除、CSV インポート/エクスポートを行います。

  • POST/api/v1/crm/bulk/deals/update— 案件を一括更新
  • POST/api/v1/crm/bulk/deals/delete— 案件を一括削除
  • POST/api/v1/crm/bulk/contacts/import— 連絡先を CSV インポート
  • GET/api/v1/crm/bulk/deals/export— 案件を CSV エクスポート
  • GET/api/v1/crm/bulk/contacts/export— 連絡先を CSV エクスポート
  • GET/api/v1/crm/bulk/companies/export— 会社を CSV エクスポート
監査ログ(Audit Logs)

CRM ドメイン内の操作履歴(作成・更新・削除など)を取得します。

  • GET/api/v1/crm/audit-logs— 監査ログ一覧を取得