連絡先(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} | 連絡先を削除 |
GET
/api/v1/crm/contacts連絡先一覧を取得
組織内の連絡先をページネーション付きで取得します。名前・メールでの検索や会社での絞り込みに対応しています。
認証が必要です— セッション Cookie または Bearer トークンを含めてください
クエリパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
limit | integer | 任意 | 1ページあたりの件数(デフォルト: 50、最大: 200) |
offset | integer | 任意 | スキップする件数 |
search | string | 任意 | 名前・メールでの部分一致検索 |
company_id | string | 任意 | 会社 ID で絞り込み |
sort | string | 任意 | ソートキー(created_at, name) |
order | string | 任意 | ソート順(asc / desc) |
レスポンスフィールド
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
| Contact[] | 任意 | 連絡先の配列 | |
total | number | 任意 | 総件数 |
limit | number | 任意 | 1ページあたりの件数 |
offset | number | 任意 | スキップした件数 |
コード例
curl "https://api.blueai.jp/api/v1/crm/contacts" \
-H "Cookie: better-auth.session_token=<token>"レスポンス例
{
"items": [
{
"id": "cont_bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
"first_name": "太郎",
"last_name": "山田",
"email": "taro@example.com",
"phone": "090-1234-5678",
"position": "部長",
"company_id": "comp_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"created_at": "2026-01-20T10:00:00Z",
"updated_at": "2026-02-05T16:00:00Z"
}
],
"total": 35,
"limit": 50,
"offset": 0
}GET
/api/v1/crm/contacts/{id}連絡先詳細を取得
指定した連絡先の詳細情報を取得します。
認証が必要です— セッション Cookie または Bearer トークンを含めてください
パスパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 必須 | 連絡先 ID |
レスポンスフィールド
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
| Contact | 任意 | 連絡先の詳細情報 |
コード例
curl "https://api.blueai.jp/api/v1/crm/contacts/cont_123e4567e89b12d3a456426614174000" \
-H "Cookie: better-auth.session_token=<token>"レスポンス例
{
"contact": {
"id": "cont_bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
"first_name": "太郎",
"last_name": "山田",
"email": "taro@example.com",
"phone": "090-1234-5678",
"position": "部長",
"company_id": "comp_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"created_at": "2026-01-20T10:00:00Z",
"updated_at": "2026-02-05T16:00:00Z"
}
}POST
/api/v1/crm/contacts連絡先を作成
新しい連絡先を登録します。
認証が必要です— セッション Cookie または Bearer トークンを含めてください
リクエストボディ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
first_name | string | 必須 | 名 |
last_name | string | 必須 | 姓 |
email | string | 任意 | メールアドレス |
phone | string | 任意 | 電話番号 |
position | string | 任意 | 役職 |
company_id | string | 任意 | 所属会社の ID |
note | string | 任意 | 備考 |
レスポンスフィールド
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
| Contact | 任意 | 作成された連絡先 |
コード例
curl -X POST "https://api.blueai.jp/api/v1/crm/contacts" \
-H "Cookie: better-auth.session_token=<token>" \
-H "Content-Type: application/json" \
-d '{
"first_name": "太郎",
"last_name": "山田",
"email": "taro@example.com",
"phone": "090-1234-5678",
"position": "部長",
"company_id": "comp_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}'レスポンス例
{
"contact": {
"id": "cont_bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
"first_name": "太郎",
"last_name": "山田",
"email": "taro@example.com",
"phone": "090-1234-5678",
"position": "部長",
"company_id": "comp_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"created_at": "2026-01-20T10:00:00Z",
"updated_at": "2026-02-05T16:00:00Z"
}
}PATCH
/api/v1/crm/contacts/{id}連絡先を更新
指定した連絡先の情報を更新します。
認証が必要です— セッション Cookie または Bearer トークンを含めてください
パスパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 必須 | 連絡先 ID |
リクエストボディ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
first_name | string | 任意 | 名 |
last_name | string | 任意 | 姓 |
email | string | 任意 | メールアドレス |
phone | string | 任意 | 電話番号 |
position | string | 任意 | 役職 |
company_id | string | 任意 | 所属会社の ID |
note | string | 任意 | 備考 |
レスポンスフィールド
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
| Contact | 任意 | 更新後の連絡先 |
コード例
curl -X PATCH "https://api.blueai.jp/api/v1/crm/contacts/cont_123e4567e89b12d3a456426614174000" \
-H "Cookie: better-auth.session_token=<token>" \
-H "Content-Type: application/json" \
-d '{
"email": "taro.yamada@newdomain.com",
"position": "本部長"
}'レスポンス例
{
"contact": {
"id": "cont_bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
"first_name": "太郎",
"last_name": "山田",
"email": "taro.yamada@newdomain.com",
"phone": "090-1234-5678",
"position": "本部長",
"company_id": "comp_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"created_at": "2026-01-20T10:00:00Z",
"updated_at": "2026-02-05T16:00:00Z"
}
}DELETE
/api/v1/crm/contacts/{id}連絡先を削除
指定した連絡先を削除します。
認証が必要です— セッション Cookie または Bearer トークンを含めてください
パスパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 必須 | 連絡先 ID |
レスポンスフィールド
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
success | boolean | 任意 | 削除成功フラグ |
コード例
curl -X DELETE "https://api.blueai.jp/api/v1/crm/contacts/cont_123e4567e89b12d3a456426614174000" \
-H "Cookie: better-auth.session_token=<token>"レスポンス例
{
"success": true
}