API Reference
Miniback provides a REST API for programmatic access to your feedback data.
Authentication
- All requests require a project API key (see dashboard)
- Pass API key via
x-api-key
header orapi_key
query param
Endpoints
Get Feedback
GET /api/projects/{projectId}/feedback
- Query: status, limit, offset
- Auth: x-api-key
Submit Feedback
POST /api/projects/{projectId}/feedback
- Body: message (required), context (optional)
- Auth: x-api-key
Widget Feedback
POST /api/feedback
- Body: message, projectSlug, context
- Header:
x-feedback-source: widget
(required for widget clients; API clients should omit or set to ‘api’)
Note:
- The
x-feedback-source
header is used to distinguish between feedback submitted from the widget and from API clients.- Widget clients must send
x-feedback-source: widget
.- If the header is omitted or set to any other value, the feedback will be marked as coming from the API.
Example Request
curl -H "x-api-key: pk_..." https://miniback.io/api/projects/PROJECT_ID/feedback
Example Response
{
"data": [
/* feedback items */
],
"pagination": { "total": 1, "limit": 10, "offset": 0, "hasMore": false }
}
Last updated on