API Documentation
Complete reference and interactive playground for the Roadmap API.
1. Authentication
Get your API Key from the dashboard settings.
All requests must include your API key in the Authorization header.
🔐 Auth Tester
Verify your API Key connectivity.
Header Value
Authorization: Bearer sk_live_...
Connectivity Check (Curl)
curl -I -X GET "https://www.clappingpeaches.com/api/roadmap/tasks" \ -H "Authorization: Bearer sk_live_..."
2. List Tasks
Retrieve a list of tasks for your project.
🛠️ List Tasks Builder
Generate GET requests with filters.
Curl
curl -X GET "https://www.clappingpeaches.com/api/roadmap/tasks" \ -H "Authorization: Bearer <YOUR_KEY>"
3. Create a Task
Add a new feature request or bug report to the roadmap.
Use the POST /api/roadmap/tasks endpoint. You can now also include SMART goals in your payload.
Note: You do not need to provide a Project ID. The API automatically infers it from your Key.
🛠️ Task Payload Builder
Generate payloads for Create (POST), List (GET), and Update (PUT) operations.
JSON Body
{
"title": "Fix login bug",
"description": "Users cannot log in with Google",
"category": "bug",
"priority": "high",
"status": "backlog",
"useCase": "Impacts 50% of users"
}Curl Command
curl -X POST "https://www.clappingpeaches.com/api/roadmap/tasks" \
-H "Authorization: Bearer <YOUR_KEY>" \
-H "Content-Type: application/json" \
-d '{"title":"Fix login bug","description":"Users cannot log in with Google","category":"bug","priority":"high","status":"backlog","useCase":"Impacts 50% of users"}'4. Interact (Vote & Comment)
Simulate community engagement by voting and commenting.
🛠️ Interaction Builder
Generate payloads for Voting (POST, DELETE) or Commenting (GET, POST, PUT, DELETE).
JSON
{
"voteType": "upvote"
}Curl
curl -X POST "https://www.clappingpeaches.com/api/roadmap/tasks/your_task_id/vote" \
-H "Authorization: Bearer <YOUR_KEY>" \
-H "Content-Type: application/json" \
-d '{
"voteType": "upvote"
}'5. Update Status
Move the task through the development lifecycle.
Update the status to in_progress or done.
🛠️ Status Update Builder
Generate payloads for updating task status.
JSON
{
"status": "done"
}Curl
curl -X PUT "https://www.clappingpeaches.com/api/roadmap/tasks/your_task_id" \
-H "Authorization: Bearer <YOUR_KEY>" \
-H "Content-Type: application/json" \
-d '{"status":"done"}'6. Review & Rate
After completion, users can leave a review (1-5 stars).
🛠️ Review Builder
Generate payloads for user reviews.
JSON
{
"rating": 5,
"content": "Excellent implementation, exactly what I wanted!"
}Curl
curl -X POST "https://www.clappingpeaches.com/api/roadmap/tasks/your_task_id/reviews" \
-H "Authorization: Bearer <YOUR_KEY>" \
-H "Content-Type: application/json" \
-d '{"rating":5,"content":"Excellent implementation, exactly what I wanted!"}'