FluentBoards Developers

# Folders

The Folders API allows you to group and organize boards in Fluent Boards. These endpoints are Pro-only and live under the admin prefix.

# Base Endpoint

/wp-json/fluent-boards/v2/admin/folders
1
{
  "id": 11,
  "title": "Lorem Ipsum",
  "created_by": "1",
  "boards_ids": [
    3
  ]
}
1
2
3
4
5
6
7
8

# List Folders

Retrieve all folders in the system.

HTTP Request

GET /wp-json/fluent-boards/v2/admin/folders
1

# Example Request

curl "https://yourdomain.com/wp-json/fluent-boards/v2/admin/folders" \
  -H "Authorization: Basic API_USERNAME:API_PASSWORD"
1
2

# Example Response

{
  "folders": [
    {
      "id": 11,
      "title": "Lorem Ipsum",
      "created_by": "1",
      "boards_ids": [
        3
      ]
    }
  ]
}
1
2
3
4
5
6
7
8
9
10
11
12

# Create a Folder

Create a new folder to organize boards.

HTTP Request

POST /wp-json/fluent-boards/v2/admin/folders
1

# Example Request

curl -X POST "https://yourdomain.com/wp-json/fluent-boards/v2/admin/folders" \
  -H "Authorization: Basic API_USERNAME:API_PASSWORD" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "title=Development"
1
2
3
4

# Request Body

Field Type Required Description
title string Yes Folder title (max 50 chars)

# Example Response

{
  "message": "Folder has been created",
  "folder": {
    "id": 12,
    "title": "Development",
    "created_by": 1,
    "boards_ids": []
  }
}
1
2
3
4
5
6
7
8
9

# Update a Folder

Update an existing folder's title.

HTTP Request

PUT /wp-json/fluent-boards/v2/admin/folders/{folder_id}
1

# Example Request

curl -X PUT "https://yourdomain.com/wp-json/fluent-boards/v2/admin/folders/{folder_id}" \
  -H "Authorization: Basic API_USERNAME:API_PASSWORD" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "title=Marketing"
1
2
3
4

# Request Body

Field Type Required Description
title string Yes New folder title

# Example Response

{
  "message": "Folder updated successfully",
  "folder": {
    "id": 11,
    "title": "Marketing",
    "created_by": "1",
    "boards_ids": []
  }
}
1
2
3
4
5
6
7
8
9

# Delete a Folder

Remove a folder from the system.

HTTP Request

DELETE /wp-json/fluent-boards/v2/admin/folders/{folder_id}
1

# Example Request

curl -X DELETE "https://yourdomain.com/wp-json/fluent-boards/v2/admin/folders/{folder_id}" \
  -H "Authorization: Basic API_USERNAME:API_PASSWORD"
1
2

# Example Response

{
  "message": "Folder deleted successfully."
}
1
2
3

# Add Boards to Folder

Add one or more boards to a folder. This replaces any existing folder assignments.

HTTP Request

POST /wp-json/fluent-boards/v2/admin/folders/{folder_id}/add-board
1

# Example Request

curl -X POST "https://yourdomain.com/wp-json/fluent-boards/v2/admin/folders/{folder_id}/add-board" \
  -H "Authorization: Basic API_USERNAME:API_PASSWORD" \
  -H "Content-Type: application/json" \
  -d '{
    "board_ids": [2,7]
  }'
1
2
3
4
5
6

# Request Body

Field Type Required Description
board_ids array[integer] Yes Board IDs to add; replaces existing folder assignment

# Example Response

{
  "message": "Added to folder successfully!"
}
1
2
3

# Remove Board from Folder

Remove a specific board from a folder.

HTTP Request

POST /wp-json/fluent-boards/v2/admin/folders/{folder_id}/remove-board
1

# Example Request

curl -X POST "https://yourdomain.com/wp-json/fluent-boards/v2/admin/folders/{folder_id}/remove-board" \
  -H "Authorization: Basic API_USERNAME:API_PASSWORD" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "board_id=7"
1
2
3
4

# Request Body

Field Type Required Description
board_id integer Yes Board ID to remove from folder

# Example Response

{
  "message": "Removed from folder successfully!"
}
1
2
3

# Error Responses

See Common Error Responses for standard error formats.

# Common Folder-Specific Errors

  • 404 Not Found - Folder not found
  • 403 Forbidden - You don't have permission to manage folders
  • 400 Bad Request - Invalid folder data or missing required fields

← Users →