ホーム/CRM（顧客管理）/データ構造

CRM データ構造

CRM API で返却される主要オブジェクトのフィールド定義です。

共通カラム

主要オブジェクトは共通して `object`, `external_id`, `source_system`, `metadata`, `livemode`, `version`, `system_updated_at`, `created_by`, `updated_by`, `deleted_at` を持ちます。

Deal object

案件を表す基本オブジェクトです。

フィールド

名前	型	必須	説明
id	string	必須	案件 ID
object	string	必須	オブジェクト種別（`crm.deal`）
organization_id	string	必須	組織 ID
external_id	string \| null	任意	外部連携ID
source_system	"salesforce" \| "import" \| "api" \| "manual"	必須	登録元システム
owner_id	string	必須	オーナーID
record_type	string	必須	レコード種別
name	string	必須	案件名
stage	"lead" \| "qualified" \| "proposal" \| "negotiation" \| "won" \| "lost"	必須	現在ステージ（lead: リード、qualified: 見込み、proposal: 提案、negotiation: 交渉、won: 成約、lost: 失注）
amount	number \| null	任意	金額
company_id	string \| null	任意	関連会社 ID
contact_id	string \| null	任意	関連連絡先 ID
assigned_member_id	string \| null	任意	担当メンバー ID
expected_close_date	string \| null	任意	成約予定日
metadata	object \| null	任意	拡張メタデータ
livemode	boolean	必須	本番モードフラグ
version	number	必須	リビジョン番号
created_by	string \| null	任意	作成者 ID
updated_by	string \| null	任意	更新者 ID
deleted_at	string \| null	任意	削除日時 (ISO 8601)
created_at	string	必須	作成日時 (ISO 8601)
system_updated_at	string	必須	システム更新日時 (ISO 8601)
updated_at	string	必須	更新日時 (ISO 8601)

{
  "id": "deal_11111111111111111111111111111111",
  "object": "crm.deal",
  "organization_id": "org_77777777777777777777777777777777",
  "external_id": "ext_org_77777777",
  "source_system": "api",
  "owner_id": "usr_99999999999999999999999999999999",
  "record_type": "default",
  "name": "Enterprise Plan - Acme Corp",
  "stage": "proposal",
  "amount": 1200000,
  "company_id": "comp_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "contact_id": "cont_bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
  "assigned_member_id": "mem_99999999999999999999999999999999",
  "expected_close_date": "2026-03-31",
  "metadata": {
    "source": "website",
    "campaign": "spring-2026"
  },
  "livemode": false,
  "version": 12,
  "created_by": "usr_99999999999999999999999999999999",
  "updated_by": "usr_88888888888888888888888888888888",
  "deleted_at": null,
  "created_at": "2026-01-15T09:00:00Z",
  "system_updated_at": "2026-02-20T14:30:00Z",
  "updated_at": "2026-02-20T14:30:00Z"
}

Company object

会社（取引先企業）を表すオブジェクトです。

フィールド

名前	型	必須	説明
id	string	必須	会社 ID
object	string	必須	オブジェクト種別（`crm.company`）
organization_id	string	必須	組織 ID
external_id	string \| null	任意	外部連携ID
source_system	"salesforce" \| "import" \| "api" \| "manual"	必須	登録元システム
owner_id	string	必須	オーナーID
record_type	string	必須	レコード種別
name	string	必須	会社名
industry	string \| null	任意	業種
website_url	string \| null	任意	Web サイト URL
email	string \| null	任意	代表メールアドレス
phone	string \| null	任意	電話番号
address	string \| null	任意	住所
metadata	object \| null	任意	拡張メタデータ
livemode	boolean	必須	本番モードフラグ
version	number	必須	リビジョン番号
created_by	string \| null	任意	作成者 ID
updated_by	string \| null	任意	更新者 ID
deleted_at	string \| null	任意	削除日時 (ISO 8601)
created_at	string	必須	作成日時 (ISO 8601)
system_updated_at	string	必須	システム更新日時 (ISO 8601)
updated_at	string	必須	更新日時 (ISO 8601)

{
  "id": "comp_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "object": "crm.company",
  "organization_id": "org_77777777777777777777777777777777",
  "external_id": "ext_org_77777777",
  "source_system": "api",
  "owner_id": "usr_99999999999999999999999999999999",
  "record_type": "default",
  "name": "Acme Corporation",
  "industry": "IT Services",
  "website_url": "https://acme.example.com",
  "email": "info@acme.example.com",
  "phone": "03-1234-5678",
  "address": "Tokyo, Minato-ku 1-2-3",
  "metadata": {
    "segment": "enterprise"
  },
  "livemode": false,
  "version": 7,
  "created_by": "usr_99999999999999999999999999999999",
  "updated_by": "usr_99999999999999999999999999999999",
  "deleted_at": null,
  "created_at": "2026-01-10T09:00:00Z",
  "system_updated_at": "2026-02-18T11:00:00Z",
  "updated_at": "2026-02-18T11:00:00Z"
}

Contact object

連絡先（担当者）を表すオブジェクトです。

フィールド

名前	型	必須	説明
id	string	必須	連絡先 ID
object	string	必須	オブジェクト種別（`crm.contact`）
organization_id	string	必須	組織 ID
external_id	string \| null	任意	外部連携ID
source_system	"salesforce" \| "import" \| "api" \| "manual"	必須	登録元システム
owner_id	string	必須	オーナーID
record_type	string	必須	レコード種別
company_id	string \| null	任意	所属会社 ID
name	string	必須	氏名
email	string \| null	任意	メールアドレス
phone	string \| null	任意	電話番号
position	string \| null	任意	役職
notes	string \| null	任意	メモ
metadata	object \| null	任意	拡張メタデータ
livemode	boolean	必須	本番モードフラグ
version	number	必須	リビジョン番号
created_by	string \| null	任意	作成者 ID
updated_by	string \| null	任意	更新者 ID
deleted_at	string \| null	任意	削除日時 (ISO 8601)
created_at	string	必須	作成日時 (ISO 8601)
system_updated_at	string	必須	システム更新日時 (ISO 8601)
updated_at	string	必須	更新日時 (ISO 8601)

{
  "id": "cont_bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
  "object": "crm.contact",
  "organization_id": "org_77777777777777777777777777777777",
  "external_id": "ext_org_77777777",
  "source_system": "api",
  "owner_id": "usr_99999999999999999999999999999999",
  "record_type": "default",
  "company_id": "comp_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "name": "Tanaka Taro",
  "email": "tanaka@acme.example.com",
  "phone": "090-1234-5678",
  "position": "CTO",
  "notes": null,
  "metadata": {
    "source": "import"
  },
  "livemode": false,
  "version": 3,
  "created_by": "usr_99999999999999999999999999999999",
  "updated_by": "usr_88888888888888888888888888888888",
  "deleted_at": null,
  "created_at": "2026-01-12T10:00:00Z",
  "system_updated_at": "2026-02-19T16:00:00Z",
  "updated_at": "2026-02-19T16:00:00Z"
}

Activity object

案件に紐づく活動履歴を表すオブジェクトです。

フィールド

名前	型	必須	説明
id	string	必須	活動 ID
object	string	必須	オブジェクト種別（`crm.activity`）
organization_id	string	必須	組織 ID
external_id	string \| null	任意	外部連携ID
source_system	"salesforce" \| "import" \| "api" \| "manual"	必須	登録元システム
owner_id	string	必須	オーナーID
record_type	string	必須	レコード種別
deal_id	string	必須	対象案件 ID
type	"call" \| "email" \| "meeting" \| "note" \| "task"	必須	活動種別（call: 電話、email: メール、meeting: 会議、note: メモ、task: タスク）
title	string	必須	タイトル
content	string \| null	任意	詳細内容
performed_at	string	必須	実施日時 (ISO 8601)
created_by	string	必須	作成者ユーザー ID
metadata	object \| null	任意	拡張メタデータ
livemode	boolean	必須	本番モードフラグ
version	number	必須	リビジョン番号
updated_by	string \| null	任意	更新者 ID
deleted_at	string \| null	任意	削除日時 (ISO 8601)
created_at	string	必須	作成日時 (ISO 8601)
system_updated_at	string	必須	システム更新日時 (ISO 8601)
updated_at	string	必須	更新日時 (ISO 8601)

{
  "id": "act_cccccccccccccccccccccccccccccccc",
  "object": "crm.activity",
  "organization_id": "org_77777777777777777777777777777777",
  "external_id": "ext_org_77777777",
  "source_system": "api",
  "owner_id": "usr_99999999999999999999999999999999",
  "record_type": "default",
  "deal_id": "deal_11111111111111111111111111111111",
  "type": "meeting",
  "title": "Product demo meeting",
  "content": "Presented new features to the client team.",
  "performed_at": "2026-02-20T13:00:00Z",
  "created_by": "usr_99999999999999999999999999999999",
  "metadata": {
    "channel": "meeting"
  },
  "livemode": false,
  "version": 2,
  "updated_by": "usr_99999999999999999999999999999999",
  "deleted_at": null,
  "created_at": "2026-02-20T14:00:00Z",
  "system_updated_at": "2026-02-20T14:00:00Z",
  "updated_at": "2026-02-20T14:00:00Z"
}