Skip to content

Fluent Boards REST API ​

Welcome to the Fluent Boards REST API documentation. This guide will help you integrate with Fluent Boards using RESTful HTTP requests to manage boards, tasks, stages, and more.

Overview ​

The Fluent Boards REST API provides programmatic access to your Fluent Boards data through standard HTTP methods. You can use this API to:

  • Manage Boards: Create, read, update, archive and delete boards
  • Handle Tasks: Manage tasks, subtasks, assignees, comments and attachments
  • Control Stages: Organize tasks with custom stages and workflows
  • Administer: Manage members and roles, webhooks, imports and global settings

Endpoints marked Pro need Fluent Boards Pro. Roadmap endpoints need the Fluent Roadmap add-on.

Base URL ​

All API requests should be made to:

https://yourdomain.com/wp-json/fluent-boards/v2

Quick Start ​

  1. Set up authentication with a WordPress Application Password.
  2. List your boards:
bash
curl "https://yourdomain.com/wp-json/fluent-boards/v2/projects" \
  -u "USERNAME:APPLICATION_PASSWORD"

Resources ​

ResourceWhat it covers
BoardsBoards (/projects): list, create, update, archive, duplicate
TasksTasks on a board: create, update, move, clone
SubtasksSubtasks and subtask groups (Pro)
StagesBoard stages (columns)
LabelsBoard labels and task labels
CommentsTask comments and replies
AttachmentsTask attachments (Pro)
Custom FieldsBoard custom fields and task values (Pro)
FoldersBoard folders
Users & MembersBoard members, invitations, board roles, member profiles
Managers & RolesGlobal admins and bulk board access (Pro)
NotificationsUser notifications and notification settings
ActivitiesBoard, task and member activity logs
Time TrackingTime entries and timesheets (Pro)
TemplatesBoard and task templates (Pro)
RoadmapsRoadmap ideas, votes and comments (Fluent Roadmap add-on)
ReportsOverview, tasks, activity, roadmap and timesheet reports
WebhooksIncoming and outgoing webhooks
Cloud StorageFile storage driver settings (Pro)
Import & ExportJSON, Trello, Asana and CSV imports
Admin SettingsModules, general settings, MCP, license
AIAI writing assistant and task AI actions
Dashboard & UtilitiesDashboard tasks, global search, selector options
Public BoardsRead-only access to boards shared publicly

To add your own endpoints under the same namespace, see Extending the REST API.

Response Format ​

Responses are JSON. There is no shared envelope: each endpoint returns the object its controller builds, so the top-level keys differ per endpoint. For example, GET /projects/{board_id}/labels returns {"labels": [...]}, and POST /projects/{board_id}/user/{user_id}/make-manager returns:

json
{
  "message": "Role updated successfully",
  "member": {
    "ID": 5,
    "display_name": "Jane Smith"
  }
}

Each endpoint page shows the exact keys. Paginated lists use the framework paginator, which includes current_page, data, per_page, total and last_page inside the key that holds the list (for example boards in GET /projects).

Error Handling ​

Errors use standard HTTP status codes. Their body depends on where the request failed:

json
{
  "code": "rest_forbidden",
  "message": "Sorry, you are not allowed to do that.",
  "data": {
    "status": 403
  }
}
json
{
  "title": {
    "required": "The title field is required."
  }
}

The first comes from WordPress when the permission check fails; the second is a 422 validation error. Most endpoint-specific errors return {"message": "..."}. See Common Error Responses for all formats.

Common HTTP Status Codes ​

CodeDescription
200Success (also used for creates)
400Bad Request
401Not authenticated
403Forbidden
404Not Found
409Conflict (for example, user already a board member)
422Validation or business-rule error
500Internal Server Error

SDKs and Tools ​

We don't provide official SDKs. The API works with any HTTP client library:

  • PHP: Guzzle, cURL, wp_remote_request()
  • JavaScript: Axios, Fetch API
  • Python: Requests
  • Ruby: Net::HTTP, HTTParty
  • Any language that supports HTTP requests

Support ​

For support and assistance:

What's Next? ​

Ready to start building? Begin with Authentication to set up your API access.