Saltar al contenido principal

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. Inicia sesion to your panel del inquilino
  2. Ve a Configuracion > API Keys
  3. Click Create API Key
  4. Copy the key immediately (it's only shown once!)

Claves 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

LimitValor
Requests per minute per tenant60

Rate limit headers are included in every response:

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

Available Endpoints

MetodoEndpointDescripcion
GET/api/v2/submissionsList submissions
GET/api/v2/submissions/{id}Get single submission
POST/api/v2/submissionsCreate a submission
GET/api/v2/productsList products
POST/api/v2/productsCreate a product
GET/api/v2/campaignsList campaigns
POST/api/v2/campaignsCreate a campaign
GET/api/v2/webhooks/configGet webhook configuration
PUT/api/v2/webhooks/configUpdate webhook configuration
GET/api/v2/webhooks/logsView 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 CodeMeaning
200Success
201Created
400Bad Request (validation error)
401Unauthorized (invalid/missing API key)
403Forbidden (insufficient permissions)
404Not Found
429Too Many Requests (rate limited)
500Server Error

Deep Dive