API Documentation Page
FeedbackPulse provides an interactive API documentation page so tenants can explore and test available endpoints.
Accessing API Docsโ
Navigate to /api-docs from the tenant dashboard to view the full API reference.
Endpoint Groupingโ
Endpoints are organized by resource:
| Resource | Description |
|---|---|
| Submissions | Create, read, update, and manage feedback submissions |
| Products | Manage products and their configurations |
| Campaigns | Create and manage feedback campaigns |
| Webhooks | Configure and manage webhook subscriptions |
Endpoint Detailsโ
Each endpoint entry displays the following information:
| Field | Description |
|---|---|
| HTTP Method | The request method (GET, POST, PUT, DELETE) |
| URL | The full endpoint path |
| Parameters | Required and optional parameters with types and descriptions |
| Example Request | Sample request body or query parameters |
| Example Response | Sample JSON response with status code |
Authenticationโ
The API docs page includes authentication instructions. All API requests require an API key passed in the request header:
Authorization: Bearer {your-api-key}
API keys can be generated from the tenant Settings page.
Copy-to-Clipboardโ
Each endpoint includes a pre-built cURL command that can be copied to the clipboard with a single click, making it easy to test endpoints from the terminal.