REST API v2 Overview

FeedbackPulse SaaS provides a RESTful API (v2) for programmatic access to your tenant data. Use it to integrate feedback into your own apps, build dashboards, or automate workflows.

---

Base URL

https://yourdomain.com/api/v2

---

Authentication

All API requests require a Bearer token (API key):

curl -H "Authorization: Bearer YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     https://yourdomain.com/api/v2/submissions

Getting an API Key

1. ログイン to your テナントダッシュボード
2. へ移動 設定 > API Keys
3. Click Create API Key
4. Copy the key immediately (it's only shown once!)

APIキー are stored as SHA256 hashes. The raw key cannot be recovered.

Plan requirement: API access requires the api_access feature flag on your plan.

---

Rate Limiting

Limit	値
Requests per minute per tenant	60

Rate limit headers are included in every response:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 57

---

Available Endpoints

メソッド	エンドポイント	説明
GET	/api/v2/submissions	List submissions
GET	/api/v2/submissions/{id}	Get single submission
POST	/api/v2/submissions	Create a submission
GET	/api/v2/products	List products
POST	/api/v2/products	Create a product
GET	/api/v2/campaigns	List campaigns
POST	/api/v2/campaigns	Create a campaign
GET	/api/v2/webhooks/config	Get webhook configuration
PUT	/api/v2/webhooks/config	Update webhook configuration
GET	/api/v2/webhooks/logs	View webhook delivery logs

---

Response Format

All responses are JSON:

{
  "data": [...],
  "meta": {
    "current_page": 1,
    "per_page": 15,
    "total": 42
  }
}

Error Responses

{
  "error": "Unauthenticated.",
  "status": 401
}

Status Code	Meaning
200	Success
201	Created
400	Bad Request (validation error)
401	Unauthorized (invalid/missing API key)
403	Forbidden (insufficient permissions)
404	Not Found
429	Too Many Requests (rate limited)
500	Server Error

---

Deep Dive

• Authentication -- API key details
• 投稿 API -- create and list feedback
• 製品 API -- manage products
• キャンペーン API -- manage campaigns
• Webhooks -- real-time event notifications