For the complete documentation index, see llms.txt
Skip to main content
Version: 2.0.0

PushFeedback API

Manage projects, feedback, integrations, and analytics with API v2.

Base URL: https://app.pushfeedback.com

Authorization & permissions​

Create an API key​

  1. As a team administrator, open Team > API keys in PushFeedback.
  2. Click Create API key, enter a name, and choose permissions. To read feedback, select feedback_read.
  3. 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.

PermissionAllows
projects_readList projects and read settings
projects_createCreate projects
projects_updateUpdate project settings
projects_deleteDelete projects and their feedback
feedback_readList and read feedback
feedback_createSubmit feedback to protected projects
feedback_updateArchive and restore feedback
feedback_deleteDelete feedback
analytics_readRead feedback analytics
integrations_readRead integration settings
integrations_createConfigure integrations
integrations_updateUpdate integrations and credentials
integrations_deleteRemove 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:

RequestsLimit
Project configuration (GET or HEAD on /api/v2/projects/{slug}/)2,500 per hour
All other v2 requests combined250 per hour

A 429 response includes Retry-After, the number of seconds to wait before retrying.

Errors​

StatusWhat to check
400Fix the request body or query parameters. Unknown body fields are rejected.
401Supply a valid key that has not expired or been revoked.
403Check the required permission, plan access, and any endpoint-specific restrictions.
404Check the resource ID and the key's project coverage.
409Update the integration that already exists instead of creating it again.
429Wait 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​

Send Authorization: Api-Key YOUR_API_KEY.

Security Scheme Type:

apiKey

Header parameter name:

Authorization