本文へスキップ
OKAERI
  • 料金
  • コラム
  • 会社情報
  • お問い合わせ
無料で始める
  • 料金
  • コラム
  • 会社情報
  • お問い合わせ
  • 無料で始める
開発者向けドキュメント › API リファレンス ›

API リファレンス:同意の設定

同意の設定(consent_settings)の操作です。共通の決まり(認証・レート制限・エラーの形)は概要を、型の詳細はスキーマを参照してください。

AI・コーディングエージェント向けにこのページの Markdown 版とllms.txtがあります。

  • サイト
  • 同意の設定
  • キャンペーン
  • シナリオ
  • 文面
  • リード
  • 配信
  • 配信スイッチ
  • 除外リスト
  • レポート
  • Webhook
  • スキーマ
  • GET /api/v1/consent_settings 同意の設定の取得(getConsentSettings)

GET /api/v1/consent_settings

同意の設定の取得

operationId:getConsentSettings 必要なスコープ:sites:read

応答

ステータス説明型
200成功ConsentSettingsOut
401APIキーが無効・失効(authentication_error)Error
403スコープ不足(permission_error / scope_insufficient)・プランの上限(plan_limit_exceeded)・APIキーではできない操作(session_required 等)Error
422パラメータ不正(invalid_request)。param に対象の項目名、message に理由(日本語)Error
429レート制限の超過(rate_limit_error)。上限はテナント単位(テナント内の全キーの合計)の直近60秒の回数で、プラン別に Free 60 / Starter 60 / Growth 300 / Pro 1,000 回。個別の設定がある場合は応答ヘッダ X-RateLimit-Limit の値が正。Retry-After(秒)の後に再試行するError
5XXサーバ側の失敗(api_error)。request_id を添えて問い合わせてください。時間をおいた再試行で解消することがある(POST は同じ Idempotency-Key を付けて再試行する)Error

OKAERI

カゴ落ち・離脱防止|フォーム離脱者を定額で呼び戻す

サイト

  • ホーム
  • 料金
  • コラム
  • 会社情報
  • お問い合わせ
  • ヘルプ・よくある質問
  • 開発者向け(API)

規約・ポリシー

  • 利用規約
  • 特定商取引法に基づく表記
  • プライバシーポリシー
  • 外部送信規律に基づく公表
  • プライバシーポリシーの記載例(導入事業者向け)

© 2026 株式会社OTEGAMI