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

会社(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}会社を削除
GET/api/v1/crm/companies

会社一覧を取得

組織内の会社をページネーション付きで取得します。名前での検索に対応しています。

認証が必要ですセッション Cookie または Bearer トークンを含めてください

クエリパラメータ

名前必須説明
limit
integer任意1ページあたりの件数(デフォルト: 50、最大: 200)
offset
integer任意スキップする件数
search
string任意会社名での部分一致検索
sort
string任意ソートキー(created_at, name)
order
string任意ソート順(asc / desc)

レスポンスフィールド

名前必須説明
Company[]任意会社の配列
total
number任意総件数
limit
number任意1ページあたりの件数
offset
number任意スキップした件数

コード例

curl "https://api.blueai.jp/api/v1/crm/companies" \
  -H "Cookie: better-auth.session_token=<token>"

レスポンス例

{
  "items": [
    {
      "id": "comp_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "name": "株式会社サンプル",
      "website": "https://example.com",
      "phone": "03-1234-5678",
      "address": "東京都渋谷区...",
      "industry": "IT",
      "email": "info@example.com",
      "created_at": "2026-01-10T09:00:00Z",
      "updated_at": "2026-02-01T12:00:00Z"
    }
  ],
  "total": 18,
  "limit": 50,
  "offset": 0
}
POST/api/v1/crm/companies

会社を作成

新しい会社を登録します。

認証が必要ですセッション Cookie または Bearer トークンを含めてください

リクエストボディ

名前必須説明
name
string必須会社名
website
string任意Webサイト URL
phone
string任意電話番号
address
string任意住所
industry
string任意業種
email
string任意代表メールアドレス
note
string任意備考

レスポンスフィールド

名前必須説明
Company任意作成された会社

コード例

curl -X POST "https://api.blueai.jp/api/v1/crm/companies" \
  -H "Cookie: better-auth.session_token=<token>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "株式会社サンプル",
  "website": "https://example.com",
  "phone": "03-1234-5678",
  "address": "東京都渋谷区...",
  "industry": "IT"
}'

レスポンス例

{
  "company": {
    "id": "comp_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "name": "株式会社サンプル",
    "website": "https://example.com",
    "phone": "03-1234-5678",
    "address": "東京都渋谷区...",
    "industry": "IT",
    "email": "info@example.com",
    "created_at": "2026-01-10T09:00:00Z",
    "updated_at": "2026-02-01T12:00:00Z"
  }
}
GET/api/v1/crm/companies/{id}

会社詳細を取得

指定した会社の詳細情報を取得します。

認証が必要ですセッション Cookie または Bearer トークンを含めてください

パスパラメータ

名前必須説明
id
string必須会社 ID

レスポンスフィールド

名前必須説明
Company任意会社の詳細情報

コード例

curl "https://api.blueai.jp/api/v1/crm/companies/comp_123e4567e89b12d3a456426614174000" \
  -H "Cookie: better-auth.session_token=<token>"

レスポンス例

{
  "company": {
    "id": "comp_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "name": "株式会社サンプル",
    "website": "https://example.com",
    "phone": "03-1234-5678",
    "address": "東京都渋谷区...",
    "industry": "IT",
    "email": "info@example.com",
    "created_at": "2026-01-10T09:00:00Z",
    "updated_at": "2026-02-01T12:00:00Z"
  }
}
PATCH/api/v1/crm/companies/{id}

会社を更新

指定した会社の情報を更新します。

認証が必要ですセッション Cookie または Bearer トークンを含めてください

パスパラメータ

名前必須説明
id
string必須会社 ID

リクエストボディ

名前必須説明
name
string任意会社名
website
string任意Webサイト URL
phone
string任意電話番号
address
string任意住所
industry
string任意業種
email
string任意代表メールアドレス
note
string任意備考

レスポンスフィールド

名前必須説明
Company任意更新後の会社

コード例

curl -X PATCH "https://api.blueai.jp/api/v1/crm/companies/comp_123e4567e89b12d3a456426614174000" \
  -H "Cookie: better-auth.session_token=<token>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "株式会社サンプル(更新)",
  "phone": "03-9876-5432"
}'

レスポンス例

{
  "company": {
    "id": "comp_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "name": "株式会社サンプル(更新)",
    "website": "https://example.com",
    "phone": "03-9876-5432",
    "address": "東京都渋谷区...",
    "industry": "IT",
    "email": "info@example.com",
    "created_at": "2026-01-10T09:00:00Z",
    "updated_at": "2026-02-01T12:00:00Z"
  }
}
DELETE/api/v1/crm/companies/{id}

会社を削除

指定した会社を削除します。

認証が必要ですセッション Cookie または Bearer トークンを含めてください

パスパラメータ

名前必須説明
id
string必須会社 ID

レスポンスフィールド

名前必須説明
success
boolean任意削除成功フラグ

コード例

curl -X DELETE "https://api.blueai.jp/api/v1/crm/companies/comp_123e4567e89b12d3a456426614174000" \
  -H "Cookie: better-auth.session_token=<token>"

レスポンス例

{
  "success": true
}