KaamFlow API Documentation
Integrate KaamFlow's powerful workspace features directly into your applications and workflows. Build custom integrations, automate tasks, and extend functionality.
Getting Started
To use the KaamFlow API, you need an API token. Tokens are available for Premium, Business, and Enterprise plans.
GET Getting Your API Token
1. Navigate to
2. Click "Generate New Token"
3. Copy your token and store it securely
4. Include in requests:
1. Navigate to
Settings → Developer Tools → API Tokens2. Click "Generate New Token"
3. Copy your token and store it securely
4. Include in requests:
Authorization: Bearer YOUR_TOKEN
Authentication
All API requests require authentication using a Bearer token in the Authorization header.
POST /api/v1/auth/login
Content-Type: application/json
Request Body:
{
"email": "user@example.com",
"password": "********"
}
Response (200 OK):
{
"token": "eyJhbGciOiJIUzI1NiIs...",
"user": { ... }
}
Content-Type: application/json
Request Body:
{
"email": "user@example.com",
"password": "********"
}
Response (200 OK):
{
"token": "eyJhbGciOiJIUzI1NiIs...",
"user": { ... }
}
Boards
Manage project boards and their properties.
GET /api/v1/boards
Authorization: Bearer {token}
Query Parameters:
•
•
Returns: Array of board objects with tasks count
Authorization: Bearer {token}
Query Parameters:
•
workspace_id (optional) - Filter by workspace•
archived (optional, default: false) - Include archived boardsReturns: Array of board objects with tasks count
POST /api/v1/boards
Content-Type: application/json
Request Body:
{
"name": "New Project Board",
"workspace_id": 123,
"description": "Board for managing project tasks",
"color": "#5A67F2"
}
Content-Type: application/json
Request Body:
{
"name": "New Project Board",
"workspace_id": 123,
"description": "Board for managing project tasks",
"color": "#5A67F2"
}
Tasks
Create, update, and manage tasks within boards.
POST /api/v1/tasks
Content-Type: application/json
Request Body:
{
"title": "Complete API documentation",
"board_id": 123,
"description": "Update all API endpoints",
"due_date": "2024-12-31",
"priority": "high"
}
Content-Type: application/json
Request Body:
{
"title": "Complete API documentation",
"board_id": 123,
"description": "Update all API endpoints",
"due_date": "2024-12-31",
"priority": "high"
}
Webhooks
Receive real-time notifications when events occur in your workspace.
POST /api/v1/webhooks
Content-Type: application/json
Request Body:
{
"url": "https://your-server.com/webhook",
"events": ["task.created", "task.updated"]
}
Content-Type: application/json
Request Body:
{
"url": "https://your-server.com/webhook",
"events": ["task.created", "task.updated"]
}
Ready to Start Building?
API access is available for Premium, Business, and Enterprise plans. Get your API token and start integrating today.
Secure Authentication
Restful API
Real-time Updates
Enterprise Security