FluentCommunity REST API
This reference covers 248 routes registered in the FluentCommunity core and module route files.
Base URL
https://your-site.com/wp-json/fluent-community/v2
Authentication
Every route runs behind a WordPress REST authentication check and then a FluentCommunity policy. Authenticate the request the way you would any WordPress REST call:
- Server to server: a WordPress Application Password sent as HTTP Basic auth. The interactive examples on these pages use this.
- In the browser: the logged-in cookie plus an
X-WP-Nonceheader carrying awp_restnonce. This is what the portal itself uses.
Authorization
Authentication only establishes who you are. Each route group then applies a policy, and the policy is what decides whether the call is allowed:
| Policy | Applies to | Requirement |
|---|---|---|
PortalPolicy | Feeds, comments, reactions, members, notifications, profile, activity, options | An active member profile with portal access. Anything other than GET also requires a logged-in user. |
SpacePolicy | Spaces | Portal access, plus per-space membership and role checks inside each method. |
AdminPolicy | Admin and settings routes | Community administrator. |
CourseAdminPolicy | Course administration | Course-creator access, and management rights over the course named in the path. |
ModerationPolicy | Moderation reports | Community moderator access; the content_moderation feature must also be enabled for the listing routes. |
TopicPolicy | Topic management | Space-manage access, with a narrow read-only exception for course creators fetching topic options. |
InvitationPolicy | Invitations | Any logged-in user with portal access; per-space moderator rights are then checked inside each method. |
Community administrator is not a WordPress administrator
AdminPolicy checks FluentCommunity's own community_admin permission (or a super admin), not the WordPress manage_options capability. A community administrator is a role FluentCommunity delegates, and it can be granted to users who have no elevated WordPress capabilities at all. Treat these routes as privileged, but do not assume the caller is a site administrator.
A route may also be gated by a feature flag (Helper::isFeatureEnabled('…')) or by the Pro plugin being active. Where that applies it is called out on the operation's own page.
Conventions
- Method override: the portal frontend sends
PUT,PATCHandDELETEasPOSTwith anX-HTTP-Method-Overrideheader. Direct API clients can use the real verbs. - Pagination: list endpoints return a paginator object (
data,total,per_page,current_page,last_page) and acceptpageandper_page. - Errors: most failures return a JSON body with a
messagekey. Note that several endpoints report a business failure as HTTP 200 with only amessage— check the body, not just the status.
Modules
| Module | Edition | Route Count | Description |
|---|---|---|---|
| Feeds API | Core (extended by Pro) | 19 | Feed creation, retrieval, discovery, ticker updates, bookmarks, and markdown preview. |
| Spaces API | Core (extended by Pro) | 23 | Space discovery, lifecycle management, joins/leaves, lock screen configuration, and group organization. |
| Members API | Core (extended by Pro) | 8 | Global member listing plus space-scoped membership management endpoints. |
| Comments API | Core | 8 | Feed comment listing, creation, updates, deletes, and single comment retrieval. |
| Reactions API | Core | 7 | Feed/comment reactions plus survey vote and survey voter endpoints. |
| Notifications API | Core | 5 | Read, unread, mark-as-read, and mark-all-read notification workflows. |
| Activity API | Core | 1 | Activity feed retrieval, including support for pinned and trending content. |
| Profile API | Core (extended by Pro) | 18 | Public profile retrieval plus profile edits, memberships, comments, spaces, and notification preferences. |
| Media API | Core (extended by Pro) | 6 | Feed media uploads, media preview cleanup, and Fluent Player video upload/content endpoints. |
| Settings API | Core (extended by Pro) | 19 | Feature flags, menu configuration, customization settings, privacy settings, and Fluent Player settings. |
| Admin API | Core (extended by Pro) | 41 | General admin settings, email/storage configuration, onboarding, profile links, and course discovery. |
| Options API | Core | 3 | Portal bootstrap variables, server-rendered sidebar HTML, and menu item payloads. |
| Courses API | Core (extended by Pro) | 51 | Portal course consumption endpoints and the full course administration surface. |
| Migrations API | Core | 4 | BuddyBoss and BuddyPress migration discovery, execution, and status polling. |
| Invitations API | Core | 5 | Invitation listing, creation, resend, delete, and link-generation endpoints. |
| Cart Integration API | Core | 5 | FluentCart-backed paywall search, creation, retrieval, and removal for spaces. |
| Reports API | PRO | 17 | Analytics, moderation reporting, and Pro reporting endpoints for administrators. |
| Documents API | PRO | 4 | Document library upload, listing, update, delete, and download-related portal endpoints. |
| Giphy API | PRO | 1 | Giphy search and media discovery endpoints exposed by the Pro media integration. |
| Leaderboard API | PRO | 3 | Public leaderboard retrieval plus administrator level configuration endpoints. |