Integrate your tools with FlowBoard using our REST API.
All API requests require a valid API key passed via the Authorization header:
Authorization: Bearer YOUR_API_KEY
Rate limit: 100 requests per minute per API key. Exceeding this returns HTTP 429.
| Header | Required | Description |
|---|---|---|
| X-User-Email | No | Your email in the workspace. Enables mine=true filter and proper comment attribution. |
https://europe-west3-flowwboard.cloudfunctions.net
/submitTaskPermission: Submit Ideas or Submit Bugs
{
"title": "Task title (3-200 characters)",
"description": "Task description (0-5000 characters)",
"type": "idea" | "bug" | "feature" | "improvement" | "fix" | "chore",
"projectId": "optional, required for feature/improvement/fix/chore",
"tags": ["optional", "array", "of", "tags"],
"metadata": { "custom": "data" }
}{
"id": "task-id",
"taskNumber": 123,
"message": "Idea submitted successfully"
}curl -X POST https://europe-west3-flowwboard.cloudfunctions.net/submitTask \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"title": "Add dark mode support",
"description": "Users want a dark mode option.",
"type": "idea",
"tags": ["ui", "feature-request"]
}'/getTasksPermission: Search Tasks
| Parameter | Type | Description |
|---|---|---|
| board | string | "bugs", "ideas", or "flows" |
| projectId | string | Filter by project ID |
| projectName | string | Filter by project name (case-sensitive) |
| tags | string | Comma-separated tags (AND logic) |
| status | string | open, in_progress, blocked, ready, done, paused |
| statuses | string | Comma-separated statuses (OR logic) |
| assignee | string | Filter by assignee user ID |
| mine | boolean | If true, filter tasks assigned to the user identified by X-User-Email header |
| type | string | feature, improvement, fix, chore, bug |
| types | string | Comma-separated types |
| limit | number | Max results (default: 100, max: 500) |
| excludeReleased | boolean | Exclude released tasks (default: true) |
| excludeArchived | boolean | Exclude archived tasks (default: true) |
| includeDeleted | boolean | Include deleted tasks (default: false) |
{
"tasks": [
{
"id": "task-id",
"taskNumber": "123",
"title": "Task title",
"status": "open",
"type": "feature",
"tags": ["client-acme"],
"projectId": "proj123",
"assignee": "user123",
"createdAt": "2024-01-01T00:00:00.000Z"
}
],
"count": 1,
"filters": { ... }
}/getTask?taskId={taskId}Permission: Search Tasks
Also accepts taskNumber as an alternative to taskId (e.g. /getTask?taskNumber=42)
{
"task": {
"id": "task-id",
"title": "Task title",
"description": "Task description",
"status": "open",
"type": "feature",
"tags": ["ui"],
"taskNumber": "123"
},
"comments": [
{
"id": "comment-id",
"text": "Comment text",
"createdBy": "user123",
"createdAt": "2024-01-01T00:00:00.000Z"
}
]
}/updateTask?taskId={taskId}Permission: Update Tasks
Also accepts taskNumber as an alternative to taskId. Include X-User-Email header for proper comment attribution.
{
"status": "open" | "in_progress" | "blocked" | "ready" | "done" | "paused",
"comment": "Add a comment (1-5000 characters)",
"assignee": "userId or empty string to clear",
"branchName": "feature/my-branch (0-200 characters)",
"externalReference": {
"type": "github_pr",
"url": "https://github.com/...",
"id": "optional",
"title": "optional"
}
}{
"success": true,
"taskId": "task-id",
"message": "Task updated successfully"
}/deleteTask?taskId={taskId}Permission: Update Tasks
Also accepts taskNumber as an alternative to taskId
Soft-deletes a task. The task can be restored from the Trash.
/listProjectsPermission: View Projects
Returns all projects in the workspace with their IDs, names, and descriptions.
/getComments?taskId={taskId}Permission: Manage Comments
Also accepts taskNumber as an alternative to taskId
Returns all comments for a given task, ordered by creation date.
/addComment?taskId={taskId}Permission: Manage Comments
Also accepts taskNumber as an alternative to taskId. Include X-User-Email header for proper comment attribution.
{
"taskId": "task-id",
"text": "Comment text (1-5000 characters)"
}/listReleasesPermission: Search Tasks
Returns all releases in the workspace with version, date, and included tasks.
/getRelease?releaseId={releaseId}Permission: Search Tasks
Returns a single release with full details including all associated tasks.
/getReleaseDraftPermission: Manage Releases
Returns the current release draft state: tasks staged for release and hotfix, version string, and deploy notes.
{
"draft": {
"version": "2.1.0",
"releaseItems": [{ "id": "...", "title": "...", "status": "done", "type": "feature", "taskNumber": 42 }],
"hotfixItems": [],
"deployNotes": "",
"updatedAt": "2026-04-14T10:00:00.000Z"
}
}/updateReleaseDraftPermission: Manage Releases
Add or remove tasks from the release/hotfix draft, or set version/deploy notes.
| Field | Type | Description |
|---|---|---|
| action | string | Required. One of: add, remove, set_version, set_deploy_notes |
| list | string | "release" (default) or "hotfix" |
| taskIds | string | Comma-separated task IDs (for add/remove) |
| taskNumbers | string | Comma-separated task numbers (alternative to taskIds) |
| version | string | Version string (for set_version) |
| deployNotes | string | Deploy notes HTML (for set_deploy_notes) |
/confirmReleasePermission: Manage Releases
Confirm and publish a release from the current draft. Creates the release document, archives all included tasks, and clears the draft.
| Field | Type | Description |
|---|---|---|
| version | string | Release version (overrides draft version) |
| name | string | Release name (defaults to "Release {version}") |
| list | string | "release" (default) or "hotfix" |
| isPublic | boolean | Make release publicly visible |
| environments | string[] | Environment tags (e.g. ["Staging", "Production"]) |
{
"success": true,
"releaseId": "abc123",
"name": "Release 2.1.0",
"version": "2.1.0",
"taskCount": 5,
"isHotfix": false,
"message": "Release \"Release 2.1.0\" confirmed with 5 task(s)."
}/voteIdea?taskId={taskId}Permission: Submit Ideas
Also accepts taskNumber as an alternative to taskId
{
"ideaId": "idea-id"
}Connect AI tools like Claude Code, Cursor, and Windsurf to FlowBoard via our MCP server. Add this to your tool's MCP configuration:
{
"mcpServers": {
"flowboard": {
"command": "npx",
"args": ["-y", "@flowboardlabs/mcp-server"],
"env": {
"FLOWBOARD_API_KEY": "YOUR_API_KEY",
"FLOWBOARD_USER_EMAIL": "you@example.com"
}
}
}
}{
"mcpServers": {
"flowboard": {
"command": "cmd",
"args": ["/c", "npx", "-y", "@flowboardlabs/mcp-server"],
"env": {
"FLOWBOARD_API_KEY": "YOUR_API_KEY",
"FLOWBOARD_USER_EMAIL": "you@example.com"
}
}
}
}FLOWBOARD_USER_EMAIL is optional but recommended — it enables "list my tasks" and attributes comments to your account.
| Code | Description |
|---|---|
| 400 | Bad Request — Missing or invalid parameters |
| 401 | Unauthorized — Missing or invalid API key |
| 403 | Forbidden — API key lacks the required permission |
| 404 | Not Found — Task or resource not found |
| 429 | Too Many Requests — Rate limit exceeded (100 req/min) |
| 500 | Internal Server Error |
Check out the MCP Server guide for AI tool integration, or the GitHub/GitLab integration guide for webhook setup. For questions, contact support@flowboard.dev.