概覽
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. This opens the in-app API Playground and the settings for API keys. Go to API Settings身份驗證
Twenty 的 API 使用 API 金鑰進行身份驗證。 每個請求到受保護的端點必須在標頭中包含一個 API 金鑰。- API 金鑰： 您可以在 Twenty 應用的 API 設置 頁面生成新 API 金鑰。 每個 API 金鑰都是授予您 CRM 數據訪問權的祕密令牌，因此請將其保存好。 如果金鑰被洩露，請從設置中撤銷並生成新的金鑰。
-
身份驗證標頭： 一旦您擁有 API 金鑰，請在 HTTP 請求的
Authorization標頭中包含它。 使用承載令牌方案。 例如：用您獲得的金鑰替換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
可通過/rest/ 或 /graphql/ 訪問。
The Core API serves as a unified interface for managing core CRM entities (people, companies, notes, tasks) and their relationships, offering both REST and GraphQL interaction models.
元數據 API
可通過/rest/metadata/ 或 /metadata/ 訪問。
元數據 API 端點允許您獲取關於您的模式和設置的信息。 例如，您可以獲取自定義字段、對象模式等的定義。
-
示例端點：
GET /rest/metadata/objects– 列出所有對象類型及其元數據（字段、關係）。GET /rest/metadata/objects/{objectName}– 獲取特定對象的元數據（例如，people，companies）。GET /rest/metadata/picklists– 獲取在 CRM 中定義的選擇列表（下拉）字段選項。