The Feedback API lets users submit bug reports, feature suggestions, and general feedback from within the platform. Submissions are posted to a configured GitHub repository as issues, keeping all product feedback centralised alongside development work.
GitHub feedback integration must be configured in Admin → Settings → Integrations → Feedback before this API is available. You will need a GitHub personal access token with issues:write permission, plus the owner and repository name to post to.
List feedback
GET /api/feedback
Returns a list of feedback items previously submitted by the authenticated user, with their current GitHub issue status.
Required permission: api.feedback.manage
curl -X GET "https://propops.yourcompany.com/api/feedback" \
-H "Authorization: Bearer <token>"
{
"success": true,
"data": [
{
"id": 12,
"github_issue_number": 204,
"title": "Export button on reports page is broken",
"type": "bug",
"status": "open",
"created_at": "2024-06-10T14:20:00Z",
"github_url": "https://github.com/your-org/your-repo/issues/204"
}
],
"count": 1,
"message": "Operation completed successfully"
}
Submit feedback
POST /api/feedback
Submits a new feedback item. A GitHub issue is created in the configured repository and the issue number is returned.
Required permission: api.feedback.manage
Requires CSRF token.
Short summary of the feedback (used as the GitHub issue title).
Feedback category: bug, feature_request, or general.
Detailed description. For bugs, include steps to reproduce, expected behaviour, and actual behaviour.
Urgency: low, medium, or high. Applied as a GitHub label.
CSRF token from GET /api/security/csrf-token.
curl -X POST "https://propops.yourcompany.com/api/feedback" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"title": "Export button on reports page is broken",
"type": "bug",
"description": "Clicking the Export button on the Financial Reports page shows a loading spinner indefinitely. No file is downloaded. Tested in Chrome 124 and Firefox 126.",
"priority": "high",
"csrf_token": "<csrf-token>"
}'
{
"success": true,
"data": {
"id": 12,
"github_issue_number": 204,
"github_url": "https://github.com/your-org/your-repo/issues/204"
},
"message": "Feedback submitted and GitHub issue created"
}
{
"success": false,
"error": "GitHub feedback integration is not configured. Contact your administrator."
}
Feedback types and labels
type | GitHub label applied |
|---|
bug | bug |
feature_request | enhancement |
general | question |
priority | GitHub label applied |
|---|
low | priority: low |
medium | priority: medium |
high | priority: high |
