Welcome to the FeedbackChimp API Quickstart! This guide will walk you through the essential steps to get you set up and making your first API requests. We’ll cover how to find your API key, authenticate your requests, and direct you to our comprehensive API documentation for further exploration.
Note: API is an exclusive feature that is only available with the Remove Branding addon.
Step 1: Obtain Your API Key
Before you can make any requests to the FeedbackChimp API, you need to obtain your API key. Here’s how:
- Log in to your FeedbackChimp account.
- Navigate to the Dashboard.
- Go to Settings--> API.
- Copy your API key.
Important: Keep your API key secure. Do not share it or commit it to public repositories like GitHub.
Step 2: Authenticate Your Requests
FeedbackChimp API uses API key authentication. You’ll need to include your API key in the header of every request you make. Here’s how to do that:
API Key Authentication
To authenticate, add an
X-API-Key header to your requests. For example, if you want to retrieve your workspace details, you can use the following curl command:curl -X GET "https://api.feedbackchimp.com/ext/api/v1/workspace/details/" \ -H "X-API-Key: YOUR_API_KEY"
Replace
YOUR_API_KEY with the key you copied earlier.Step 3: Make Your First API Request
Now that you have your API key and understand how to authenticate, you can make your first API request! Here’s a simple example to get your workspace details:
curl -X GET "https://api.feedbackchimp.com/ext/api/v1/workspace/details/" \ -H "X-API-Key: YOUR_API_KEY"
After executing this command, you should receive a response containing the details of your workspace.
API Documentation
Looking to explore all the available API endpoints and functionalities? You can find the full API reference and detailed documentation at:
If you need any help or encounter issues, feel free to reach out to our team at [email protected].