Skip to content

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-Nonce header carrying a wp_rest nonce. 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:

PolicyApplies toRequirement
PortalPolicyFeeds, comments, reactions, members, notifications, profile, activity, optionsAn active member profile with portal access. Anything other than GET also requires a logged-in user.
SpacePolicySpacesPortal access, plus per-space membership and role checks inside each method.
AdminPolicyAdmin and settings routesCommunity administrator.
CourseAdminPolicyCourse administrationCourse-creator access, and management rights over the course named in the path.
ModerationPolicyModeration reportsCommunity moderator access; the content_moderation feature must also be enabled for the listing routes.
TopicPolicyTopic managementSpace-manage access, with a narrow read-only exception for course creators fetching topic options.
InvitationPolicyInvitationsAny 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, PATCH and DELETE as POST with an X-HTTP-Method-Override header. Direct API clients can use the real verbs.
  • Pagination: list endpoints return a paginator object (data, total, per_page, current_page, last_page) and accept page and per_page.
  • Errors: most failures return a JSON body with a message key. Note that several endpoints report a business failure as HTTP 200 with only a message — check the body, not just the status.

Modules

ModuleEditionRoute CountDescription
Feeds APICore (extended by Pro)19Feed creation, retrieval, discovery, ticker updates, bookmarks, and markdown preview.
Spaces APICore (extended by Pro)23Space discovery, lifecycle management, joins/leaves, lock screen configuration, and group organization.
Members APICore (extended by Pro)8Global member listing plus space-scoped membership management endpoints.
Comments APICore8Feed comment listing, creation, updates, deletes, and single comment retrieval.
Reactions APICore7Feed/comment reactions plus survey vote and survey voter endpoints.
Notifications APICore5Read, unread, mark-as-read, and mark-all-read notification workflows.
Activity APICore1Activity feed retrieval, including support for pinned and trending content.
Profile APICore (extended by Pro)18Public profile retrieval plus profile edits, memberships, comments, spaces, and notification preferences.
Media APICore (extended by Pro)6Feed media uploads, media preview cleanup, and Fluent Player video upload/content endpoints.
Settings APICore (extended by Pro)19Feature flags, menu configuration, customization settings, privacy settings, and Fluent Player settings.
Admin APICore (extended by Pro)41General admin settings, email/storage configuration, onboarding, profile links, and course discovery.
Options APICore3Portal bootstrap variables, server-rendered sidebar HTML, and menu item payloads.
Courses APICore (extended by Pro)51Portal course consumption endpoints and the full course administration surface.
Migrations APICore4BuddyBoss and BuddyPress migration discovery, execution, and status polling.
Invitations APICore5Invitation listing, creation, resend, delete, and link-generation endpoints.
Cart Integration APICore5FluentCart-backed paywall search, creation, retrieval, and removal for spaces.
Reports APIPRO17Analytics, moderation reporting, and Pro reporting endpoints for administrators.
Documents APIPRO4Document library upload, listing, update, delete, and download-related portal endpoints.
Giphy APIPRO1Giphy search and media discovery endpoints exposed by the Pro media integration.
Leaderboard APIPRO3Public leaderboard retrieval plus administrator level configuration endpoints.

FluentCommunity developer documentation