API Documentation

Build powerful integrations with the Boostly REST API

⚡ REST API
🔒 OAuth 2.0
📊 Real-time

🔐 Authentication

All API requests require authentication using your API key. Include your key in the Authorization header:

HTTP
Authorization: Bearer YOUR_API_KEY

💡 Tip: Keep your API key secure and never expose it in client-side code.

⏱️ Rate Limits

API requests are limited to 10,000 requests per hour per API key. Rate limit information is included in response headers:

X-RateLimit-Limit Request limit per hour
X-RateLimit-Remaining Remaining requests
X-RateLimit-Reset Time when limit resets

⚠️ Error Handling

The API uses standard HTTP status codes and returns JSON error responses:

JSON
{
  "error": {
    "code": "invalid_request",
    "message": "The request is missing required parameters"
  }
}

👥 Users API

Create User

POST /api/v1/users

Create a new user in your Boostly workspace.

Request Body
{
  "email": "user@example.com",
  "properties": {
    "name": "John Doe",
    "plan": "growth"
  }
}

📈 Events API

Track Event

POST /api/v1/events

Track user events and behaviors for conversion optimization.

Request Body
{
  "user_id": "user_123",
  "event": "trial_started",
  "properties": {
    "plan": "growth",
    "source": "website"
  }
}

🔄 Flows API

Trigger Flow

POST /api/v1/flows/trigger

Programmatically trigger conversion flows for specific users.

Request Body
{
  "flow_id": "flow_456",
  "user_id": "user_123",
  "context": {
    "page": "/dashboard"
  }
}

Need Help Getting Started?

Our developer support team is here to help you integrate quickly and efficiently.