PushFeedback API
Manage projects, feedback, integrations, and analytics with API v2.
Base URL: https://app.pushfeedback.com
Authorization & permissions
Create an API key
- As a team administrator, open Team > API keys in PushFeedback.
- Click Create API key, enter a name, and choose permissions. To read feedback, select
feedback_read. - Choose one project or All projects, then create and copy the key. It is shown once.
Creating keys requires Unlimited. See API key security for storage and revocation.
Using your API key
Send Authorization: Api-Key YOUR_API_KEY with each authenticated request:
curl 'https://app.pushfeedback.com/api/v2/projects/YOUR_PROJECT_ID/feedback/?limit=20' \
-H 'Authorization: Api-Key YOUR_API_KEY'
Replace YOUR_API_KEY with your key and YOUR_PROJECT_ID with the project's ID from the dashboard. Single-entry endpoints use the feedback slug returned by the API as YOUR_FEEDBACK_ID.
Keep feedback-reading, analytics, and management keys on your server. Anyone who can view a page can read keys embedded in it.
Available permissions
Each endpoint lists its required permission. A key covers one project or its team, as selected when you create it.
| Permission | Allows |
|---|---|
projects_read | List projects and read settings |
projects_create | Create projects |
projects_update | Update project settings |
projects_delete | Delete projects and their feedback |
feedback_read | List and read feedback |
feedback_create | Submit feedback to protected projects |
feedback_update | Archive and restore feedback |
feedback_delete | Delete feedback |
analytics_read | Read feedback analytics |
integrations_read | Read integration settings |
integrations_create | Configure integrations |
integrations_update | Update integrations and credentials |
integrations_delete | Remove integrations |
Integration permissions are separate from project permissions. For older permission names, see migration from v1.
Public widget requests
Read widget configuration and submit feedback without a key unless the project enables require_submit_key.
Protected projects require projects_read for configuration and feedback_create for submission. See submission keys before putting a key in browser code.
Pagination
List endpoints accept limit (default 20, maximum 100) and offset (default 0).
Responses contain count, next, previous, and results. Follow next until it is null, keeping your filters.
Rate limits
Limits apply per client IP address:
| Requests | Limit |
|---|---|
Project configuration (GET or HEAD on /api/v2/projects/{slug}/) | 2,500 per hour |
| All other v2 requests combined | 250 per hour |
A 429 response includes Retry-After, the number of seconds to wait before retrying.
Errors
| Status | What to check |
|---|---|
400 | Fix the request body or query parameters. Unknown body fields are rejected. |
401 | Supply a valid key that has not expired or been revoked. |
403 | Check the required permission, plan access, and any endpoint-specific restrictions. |
404 | Check the resource ID and the key's project coverage. |
409 | Update the integration that already exists instead of creating it again. |
429 | Wait for Retry-After before retrying. |
Request-level errors use {"error": "..."}. Body validation errors use field names, for example {"rating": ["..."]}.
Correct the cause before retrying a failed request.
Versioning
Use /api/v2/ for new integrations. Existing v1 clients can follow the migration guide.
Authentication
- API Key: ApiKeyAuth
Send Authorization: Api-Key YOUR_API_KEY.
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | Authorization |