Skip to main content

Is the FC API Documentation Available?

Hi! I’d like to ask whether there is already any available API documentation for FC. If so, could you please share the link or the current status?

Shahjahan Jewel

Both REST API doc and the Developers docs will be released later this week.

Ross FCA

Shahjahan JewelΒ πŸ‘€

Szabolcs BalΓ‘zs

Shahjahan JewelΒ πŸ‘€

Thomas Oates

Shahjahan JewelΒ Any update? The FluentCommunity API documentation has been promised for quite a while. Thanks!!

Szabolcs BalΓ‘zs

Till that I created a v0 version for myself may its will be useful for somebody

FluentCommunity REST API Documentation (Unofficial)

This document lists the WordPress REST API endpoints for the fluent-community/v2 namespace.

Base URL: {domain}/wp-json/fluent-community/v2

Authentication: While some GET requests might be public, most actions (especially POST, PUT, PATCH, DELETE) require an authenticated request (e.g., using a WordPress Application Password).


Feeds (Posts)

Endpoints for managing the community feed and its interactions.

GET /feeds

Lists posts. Supports pagination and filtering (e.g., ?page=1&per_page=10).

POST /feeds

Creates a new post (feed). Based on code-snippets.md, the expected payload is:

JSON

{
  "message": "The post content (markdown).",
  "space_id": 1,
  "user_id": (The_BOT_USER_ID)
}

GET /feeds/{feed_id}/by-id

Retrieves a specific post by its ID.

GET /feeds/{feed_slug}/by-slug

Retrieves a specific post by its slug.

POST /feeds/{feed_id}

Updates an existing post.

PATCH /feeds/{feed_id}

Partially updates an existing post.

DELETE /feeds/{feed_id}

Deletes a post.

POST /feeds/media-upload

Uploads a media file (image, video) for a post or comment. This typically expects a multipart/form-data request.

POST /feeds/{feed_id}/react

Adds a reaction (e.g., "like") to a post. The payload likely includes the reaction type.

GET /feeds/{feed_id}/reactions

Lists the reactions for a specific post.

GET /feeds/{feed_id}/comments

Lists the comments for a specific post.

POST /feeds/{feed_id}/comments

Adds a new comment to a post. Expected payload:

JSON

{
  "message": "The text of the comment."
}

POST /feeds/{feed_id}/comments/{comment_id}

Updates an existing comment.

DELETE /feeds/{feed_id}/comments/{comment_id}

Deletes a comment.

POST /feeds/{feed_id}/comments/{comment_id}/reactions

Adds a reaction to a specific comment.

GET /feeds/bookmarks

Lists the authenticated user's bookmarked posts.

GET /feeds/ticker

Retrieves recent activity (e.g., new post/comment count) since a given timestamp.

POST /feeds/{feed_id}/apps/survey-vote

Casts a vote in a survey/poll within a post.

GET /feeds/{feed_id}/apps/survey-voters/{option_slug}

Lists the users who voted for a specific poll option.


Spaces (Groups)

Endpoints for managing community spaces (groups).

GET /spaces

Lists all available spaces.

POST /spaces

Creates a new space.

GET /spaces/discover

Lists discoverable spaces.

GET /spaces/{spaceSlug}/by-slug

Retrieves a space's data by its slug.

PUT /spaces/{spaceSlug}/by-slug

Updates a space by its slug.

PUT /spaces/{spaceId}/by-id

Updates a space by its ID.

DELETE /spaces/{spaceId}/by-id

Deletes a space by its ID.

POST /spaces/{spaceSlug}/join

Joins a space.

POST /spaces/{spaceSlug}/leave

Leaves a space.

GET /spaces/{spaceSlug}/members

Lists a space's members.

POST /spaces/{spaceSlug}/members

Add/manage members in a space.

POST /spaces/{spaceSlug}/members/remove

Removes a member from a space.

GET /spaces/space_groups

Lists groups of spaces.


Profile (User Profile)

Endpoints for user profiles and related actions.

GET /profile/{username}

Retrieves a user's profile data by username.

POST /profile/{username}

Updates a user's profile data.

PUT /profile/{username}

Updates a user's profile data (typically a full replacement).

GET /profile/{username}/spaces

Lists the spaces a user is a member of.

GET /profile/{username}/comments

Lists a user's comments.

POST /profile/{username}/follow

Follows a user.

POST /profile/{username}/unfollow

Unfollows a user.

GET /profile/{username}/followers

Lists a user's followers.

GET /profile/{username}/followings

Lists the users that this user follows.

POST /profile/{username}/block

Blocks a user.

POST /profile/{username}/unblock

Unblocks a user.

GET /profile/{username}/notification-preferences

Retrieves notification preferences for a user.

POST /profile/{username}/notification-preferences

Updates notification preferences for a user.


Chat (Messaging)

Endpoints for the Fluent Chat module.

GET /chat/threads

Lists the user's chat threads.

POST /chat/threads

Starts a new chat thread (typically by specifying users).

GET /chat/unread_threads

Retrieves unread chat threads.

POST /chat/read-threads

Marks chat thread(s) as read.

GET /chat/users

Searches/lists users for starting a chat.

GET /chat/messages/{thread_id}

Retrieves messages from a specific chat thread.

POST /chat/messages/{thread_id}

Sends a new message to a chat thread.

POST /chat/messages/delete/{message_id}

Deletes a chat message.

POST /chat/threads/join/{thread_id}

Joins a chat thread.

POST /chat/threads/leave/{thread_id}

Leaves a chat thread.

POST /chat/threads/block/{thread_id}

Blocks a chat thread (or user).

POST /chat/threads/unblock/{thread_id}

Unblocks a chat thread.


Notifications

GET /notifications

Lists the user's notifications.

GET /notifications/unread

Lists only unread notifications.

POST /notifications/mark-read/{notification_id}

Marks a specific notification as read.

POST /notifications/mark-read/{feed_id}/by-feed-id

Marks all notifications related to a specific post as read.

POST /notifications/mark-all-read

Marks all notifications as read.


Admin (Administration)

These endpoints require administrative privileges.

GET /admin/general

Retrieves general settings.

POST /admin/general

Saves general settings.

GET /admin/email-settings

Retrieves email settings.

POST /admin/email-settings

Saves email settings.

GET /admin/storage-settings

Retrieves cloud storage (S3, R2, etc.) settings.

POST /admin/storage-settings

Saves cloud storage settings.

GET /admin/leaderboards/levels

Retrieves leaderboard levels.

POST /admin/leaderboards/levels

Configures leaderboard levels.

GET /admin/user-badges

Retrieves user badges.

POST /admin/user-badges

Manages user badges.

GET /admin/webhooks

Lists incoming webhooks.

POST /admin/webhooks

Configures a new webhook.

DELETE /admin/webhooks/{id}

Deletes a webhook.

GET /admin/users

Lists users for administrative purposes.

GET /admin/managers

Lists community managers.

POST /admin/managers

Adds a new manager.

DELETE /admin/managers/{user_id}

Removes a manager.


Other Endpoints

GET /leaderboard

Retrieves public leaderboard data.

GET /members

Lists members of the community (public list).

GET /activities

Retrieves the global activity stream.

GET /documents

Lists documents (if module is enabled).

POST /documents/upload

Uploads a document.

GET /options/app-vars

Retrieves client-side variables needed for the application (settings, enabled features, etc.).

POST /moderation/report

Reports content (post, comment) for moderation.

GET /moderation/reports

Luke Nova

Szabolcs BalΓ‘zsΒ this is AWESOME! thank you!!

+1

Rafael Piton

+1

Szabolcs BalΓ‘zs

Any update Shahjahan JewelΒ ? Thanks in advance bcuz i have to dev a lot of addons

Ferenc Torok

Please make this happen. Cheers.