概要
Twenty APIは、開発者がTwenty CRMプラットフォームをプログラムで操作することを可能にします。 APIを使用すると、Twentyを他のシステムと統合し、データ同期を自動化し、顧客データを中心にカスタムソリューションを構築できます。 APIは、作成、読み取り、更新、削除 などのコアCRMオブジェクト（人物や企業など）を操作するエンドポイントを提供し、メタデータの設定にもアクセスできます。 APIプレイグラウンド： アプリの設定内でAPIプレイグラウンドにアクセスできます。 To try out API calls in real-time, log in to your Twenty workspace and navigate to Settings → APIs & Webhooks. これにより、アプリ内APIプレイグラウンドとAPIキーの設定が開きます。 API設定に進む認証
TwentyのAPIは認証にAPIキーを使用します。 保護されたエンドポイントへの全てのリクエストには、ヘッダーにAPIキーを含める必要があります。- APIキー: TwentyアプリのAPI設定ページで新しいAPIキーを生成できます。 各APIキーはCRMデータへのアクセスを許可する秘密トークンなので、安全に保管してください。 キーが漏洩した場合は、設定から解除し、新しいものを生成してください。
-
認証ヘッダー: APIキーを取得したら、HTTPリクエストの
Authorizationヘッダーにそれを含めてください。 Bearerトークン方式を使用してください。 例:YOUR_API_KEYを取得したキーに置き換えてください。 このヘッダーは全てのAPIリクエストに必要です。 トークンが欠落しているか無効な場合、APIは認証エラー（HTTP 401 未認可）で応答します。
APIエンドポイント
全てのリソースにRESTまたはGraphQLを介してアクセスできます。- クラウド:
https://api.twenty.com/またはカスタムドメイン/サブドメイン - Self-Hosted Instances: If you are running Twenty on your own server, use your own domain in place of
api.twenty.com(for example,https://{your-domain}/rest/).
コアAPI
Accessed on/rest/ or /graphql/.
コアAPIはコアCRMエンティティ（人物、企業、ノート、タスク）とその関係を管理するための統一されたインターフェイスを提供し、RESTとGraphQLのインタラクションモデルを提供します。
メタデータAPI
/rest/metadata/または/metadata/上でアクセスされます。
メタデータAPIエンドポイントはスキーマと設定に関する情報を取得することができます。 例えば、カスタムフィールド、オブジェクトスキーマなどの定義を取得できます。
-
エンドポイントの例：
GET /rest/metadata/objects– 全オブジェクトタイプとそのメタデータ（フィールド、関係）をリスト表示。GET /rest/metadata/objects/{objectName}– 特定のオブジェクト（例：人物、企業）のメタデータを取得。GET /rest/metadata/picklists– CRMで定義されたピックリスト（ドロップダウン）フィールドオプションを取得。