導入を相談無料で始める

Object API

企業、商品、受注、売上請求、入金、在庫など、ワークスペース内のレコードを読み書きするAPIです。

最終更新日: 2026/7/9

概要

Object API は、Sanka ワークスペース内のレコードを読み取り、作成、更新、アーカイブするための API です。エンドポイントは /v2/public/... 名前空間を使い、v1 から移行しやすいように可能な限り既存の構造を維持しています。v2 移行メモ: Public API v1 は廃止予定です。/v1/public/... を利用している場合は、2026 年 6 月 25 日（木）09:00 JST（2026 年 6 月 25 日 00:00 UTC）までに /v2/public/... へ移行してください。

含まれるページ

Object API の各ページは、Sanka で扱うレコード単位に分かれています。リクエスト本文、レスポンス項目、フィルタ、プレイグラウンドを確認したいときは、対象オブジェクトのページを開いてください。
オブジェクト一覧取得作成更新削除補足
Deals (/v2/public/deals)✅✅✅✅✅旧 /v1/public/cases エイリアスが残っている場合がありますが、公開ドキュメントでは /deals を使用します
Companies✅✅✅✅✅external_id によるUpsert対応。削除はアーカイブです
Contacts✅✅✅✅✅external_id によるUpsert対応。削除はアーカイブです
Orders✅✅✅✅✅単件・一括作成に対応。削除はアーカイブです
Items✅✅✅✅✅external_id によるUpsert対応。削除はアーカイブです
Inventories✅✅✅✅✅external_id によるUpsert対応。削除はアーカイブです
Inventory Transactions✅✅✅✅✅削除はアーカイブです
Subscriptions✅✅✅✅✅削除はアーカイブです
Estimates✅✅✅✅✅削除はアーカイブです
Invoices✅✅✅✅✅削除はアーカイブです
Purchase Orders✅✅✅✅✅external_id によるUpsert対応。削除はアーカイブです
Expenses (/v2/public/expenses)✅✅✅✅✅external_id によるUpsert対応。削除はアーカイブです
Bills✅✅✅✅✅external_id によるUpsert対応。削除はアーカイブです
Disbursements✅✅✅✅✅external_id によるUpsert対応。削除はアーカイブです
Revenue✅✅✅✅✅external_id によるUpsert対応。削除はアーカイブです
Payments✅✅✅✅✅external_id によるUpsert対応。削除はアーカイブです
Locations✅✅✅✅✅external_id によるUpsert対応。削除はアーカイブです
Meters✅✅✅✅✅external_id によるUpsert対応。削除はアーカイブです
Employees✅✅❌❌❌従業員レコードを参照し、人事関連の処理につなげます
Workflows✅✅✅✅❌Workflow/action parity では GET /api/v2/public/workflows、POST /api/v2/public/workflows、PATCH /api/v2/public/workflows/{workflow_ref}、GET /api/v2/public/workflows/actions、POST /api/v2/public/workflows/{workflow_ref}/run、GET /api/v2/public/workflow-runs/{run_id} を使用します
Reports✅✅✅✅✅Salesforce形式の reportMetadata を利用。削除はアーカイブです
Properties (Schema)✅✅✅✅✅対象オブジェクトのページでプロパティエンドポイントが公開されている、主要なコマース、財務、CRM、人事オブジェクトで書き込みに対応します
企業
顧客、仕入先、パートナー、取引先のレコードを管理します。
連絡先
企業や各種レコードに紐づく担当者情報を管理します。
商品
商品、サービス、SKU、請求対象の項目を管理します。
在庫
ロケーション別の在庫数や在庫レコードを扱います。
受注
確定した受注を作成し、出荷や請求につなげます。
売上請求
顧客向けの売上請求を作成、更新、送信、追跡します。
入金
受け取った入金を登録し、売上請求に消し込みます。
発注
仕入先への発注依頼や購買レコードを管理します。
従業員
従業員レコードを参照し、人事関連の処理につなげます。
ワークフロー、承認、ログ確認のように複数オブジェクトを横断する API は、サイドバー上では別の API グループとして表示しています。Workflow/action parity では GET /api/v2/public/workflows、POST /api/v2/public/workflows、PATCH /api/v2/public/workflows/{workflow_ref}、GET /api/v2/public/workflows/actions、POST /api/v2/public/workflows/{workflow_ref}/run、GET /api/v2/public/workflow-runs/{run_id} を使用します。

使い方

  1. Sanka で開発者 API キーを作成します。
  2. 操作したいレコードに対応するオブジェクトページを選びます。
  3. まず GET の一覧・詳細取得で、項目名や ID を確認します。
  4. 書き込みが必要な場合は、対象オブジェクトが対応している POST、PUT、PATCH を使います。
  5. 返ってきた Sanka 側の ID と、自社システム側の外部 ID を保存し、次回以降の同期に使います。
一覧取得の例:
cURL
curl "https://api.sanka.com/v2/public/orders" \
  -H "Authorization: Bearer <api_key>" \
  -H "Content-Type: application/json"
他システムと同期する場合は、対応オブジェクトでは external_id のような安定した外部参照を使ってください。重複作成を防ぎ、リトライもしやすくなります。

よく使う流れ

目的最初に使うページ続けて使うページ
顧客データを取り込む企業連絡先、プロパティ、関連付け
商品マスタを同期する商品在庫、入出庫
請求フローを作る受注売上請求、入金
購買を管理する発注仕入請求、支払
人事データを扱う従業員欠勤、勤怠記録
多くの削除エンドポイントは、レコードを完全削除せずアーカイブします。各オブジェクトページに明記がない限り、削除はレコードのライフサイクル変更として扱ってください。

次のステップ

  • 認証 で開発者 API キーの作成とローテーション方法を確認します。
  • ベース URL で API ファミリーごとの名前空間を確認します。
  • サイドバーから対象オブジェクトのページを開き、API プレイグラウンドでリクエストを試します。
  • 会社データの補完やスコアリングには AI API、外部データからの会社候補検索には Data API を使います。
PreviousPOST Score RecordNext企業