REST API を使用すると、会社のデータにプログラムからアクセスできます。連携を構築する開発者向けのもので、日常の利用には不要です。
- API リファレンス:完全なリファレンスはワークスペースのアドレスの /docs/api で公開されており、OpenAPI ドキュメントは /docs/api/openapi.yaml と /docs/api/openapi.json にあります。設定の API と Webhook からリンクされています。
- ベース URL:API と Webhook の上部に表示されます。末尾は /api/v1 です。
- 認証:Authorization: Bearer の後にトークンを続けたヘッダーと、Accept: application/json を送信します。
- レスポンス:JSON のみ。単一のレコードは data で囲まれ、一覧ではカーソルページネーション用に meta と links が追加されます(limit と cursor パラメーター、1 ページ最大 100 件)。
- 安全な再試行:POST リクエストでは Idempotency-Key ヘッダーを送信します。同じキーで同じリクエストを繰り返すと、2 件目のレコードを作成する代わりに保存済みのレスポンスが返されます。キーは 24 時間保持されます。
- レート制限:トークンごとに 1 分あたり 120 リクエスト。X-RateLimit-Limit と X-RateLimit-Remaining ヘッダーで現在の状況がわかります。制限を超えると、Retry-After ヘッダー付きの 429 が返されます。
リクエストでできること
呼び出しが成功するのは、トークンにその権限(例:invoices:write)があり、トークンのユーザーがアプリ内で対応する権限を持っている場合のみです。画面と同じ業務ルールが適用されるため、発行済みの請求書は API でも編集できません。
関連ガイド
製品について質問
ソフトウェアでできること、作業の進め方、対応している国や言語について質問してください。回答はこれらのガイドに基づいています。
AI は間違えることがあります。リンク先のガイドを確認してください。