API Documentation
Integrate IdeaLift with your tools using our REST API.
Base URL
https://idealift.startvest.ai/api/v1/zapierAuthentication
All API requests require an API key. Include your API key in the Authorization header:
Authorization: Bearer YOUR_API_KEY
Get your API key from the Integrations page in your dashboard.
Endpoints
GET
/authTest your API key and get workspace information.
Response
{
"valid": true,
"workspace": {
"id": "uuid",
"name": "My Workspace",
"plan": "pro"
}
}Example Request
curl -X GET "https://idealift.startvest.ai/api/v1/zapier/auth" \ -H "Authorization: Bearer YOUR_API_KEY"
GET
/ideasGet recent ideas from your workspace.
Query Parameters
| Param | Type | Default | Description |
|---|---|---|---|
| limit | integer | 10 | Number of ideas to return (max 100) |
Response
[
{
"id": "uuid",
"title": "Add dark mode support",
"summary": "Users have requested dark mode...",
"source": "discord",
"authorName": "John Doe",
"url": "https://example.com/article",
"createdAt": "2024-12-14T10:30:00.000Z"
}
]POST
/ideasCreate a new idea in your workspace.
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| title | string | Yes | The idea title (max 255 chars) |
| summary | string | No | Detailed description of the idea |
| url | string | No | Source URL (for deduplication) |
| source | string | No | Where the idea came from (e.g., "slack", "email") |
| authorName | string | No | Name of the person who submitted the idea |
| authorId | string | No | Unique identifier for the author |
Response (201 Created)
{
"id": "uuid",
"title": "Add dark mode support",
"status": "created"
}Response (Duplicate Detected)
{
"status": "skipped",
"reason": "Duplicate idea",
"id": null
}Example Request
curl -X POST "https://idealift.startvest.ai/api/v1/zapier/ideas" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"title": "Add dark mode support",
"summary": "Users have requested dark mode for better nighttime usage",
"source": "customer_feedback",
"authorName": "John Doe"
}'POST
/webhooks/subscribeSubscribe to webhook notifications for new ideas (used by Zapier REST Hook triggers).
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| hookUrl | string | Yes | The URL to send webhook payloads to |
| event | string | No | Event type (default: "new_idea") |
Response (201 Created)
{
"id": "uuid",
"hookUrl": "https://hooks.zapier.com/...",
"event": "new_idea"
}Webhook Payload
When a new idea is created, your webhook URL will receive:
{
"id": "uuid",
"title": "Feature request title",
"summary": "Detailed description...",
"source": "discord",
"authorName": "John Doe",
"url": "https://discord.com/...",
"createdAt": "2024-12-14T10:30:00.000Z"
}DELETE
/webhooks/subscribe/:idUnsubscribe from webhook notifications.
Path Parameters
| Param | Type | Description |
|---|---|---|
| id | string | The webhook subscription ID returned from subscribe |
Response (200 OK)
{
"success": true
}Example Request
curl -X DELETE "https://idealift.startvest.ai/api/v1/zapier/webhooks/subscribe/WEBHOOK_ID" \ -H "Authorization: Bearer YOUR_API_KEY"
Error Codes
| Code | Description |
|---|---|
| 400 | Bad Request - Missing or invalid parameters |
| 401 | Unauthorized - Invalid or missing API key |
| 403 | Forbidden - Plan limit reached |
| 500 | Internal Server Error |
Rate Limits
API requests are subject to the following limits based on your plan:
| Plan | Ideas/Month |
|---|---|
| Free | 30 |
| Pro | 500 |
| Team | Unlimited |
| Business | Unlimited |
Zapier Integration
IdeaLift integrates with Zapier to connect with 5,000+ apps. Use our Zapier integration to:
- • Capture ideas from emails, forms, or other apps
- • Automatically create ideas from customer feedback
- • Sync ideas with your existing workflow tools
Need Help?
Having trouble with the API? Contact our support team:
support@startvest.ai