Browse documentation

Developers

REST API

Submit, list, search, and update project feedback from trusted server-side code.

Authentication

Send the project API key in X-API-Key. Keep this key on a trusted server. The key scopes every request to one project.

Submit feedbackbash
curl https://app.feedbacks.dev/api/v1/feedback \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_PROJECT_API_KEY" \
  -d '{
    "message": "Export gets stuck at 90%",
    "type": "bug",
    "priority": "high",
    "tags": ["export"],
    "url": "https://example.com/reports"
  }'

Core endpoints

MethodPathPurpose
GET/api/v1/projectsReturn the project available to the key
GET/api/v1/projects/:idProject details and feedback statistics
GET/api/v1/projects/:id/setup-packetExact snippets and verification guidance
POST/api/v1/feedbackCreate feedback
GET/api/v1/feedbackList or search feedback with filters and pagination
PATCH/api/v1/projects/:id/feedback?feedback_id=:idUpdate status, priority, or tags

Submission validation

  • message: required, 2 to 5000 characters.
  • type: bug, idea, praise, or question.
  • priority: low, medium, high, or critical.
  • rating: integer from 1 to 5.
  • tags: up to 10 unique values.
  • metadata: up to 4 KB.
  • structured_data: up to 10 KB.
  • url: HTTP or HTTPS only.

Handle errors by status

StatusAction
400Correct invalid request data before retrying.
401Provide a valid project API key.
403Check plan access or feedback quota.
429Back off before retrying.
500Treat the result as uncertain, inspect the inbox, then retry safely.