buddyboss/get-community-overview reports which of BuddyBoss’s sixteen components are switched on, the community’s size, the site-wide settings, and what the current user is permitted to do.
Start here. On a typical site roughly two thirds of this suite is unreachable, and this is the call that says which parts.
At a glance
| Ability | buddyboss/get-community-overview |
| Toolset | BuddyBoss — toolset/buddyboss |
| Group | BuddyBoss › Orientation & Reporting |
| Requires | AcrossAI Pro, plus BuddyBoss Platform active on the site |
| Capability | manage_options |
| Safety | Read-only — changes nothing |
| Repeatable | Idempotent — running it twice leaves the same result |
| Ships in | AcrossAI Pro 0.9.16 and later |
How it works
BuddyBoss registers a component’s REST routes only while that component is active, so a large share of this suite is unreachable on any given site. buddyboss/get-community-overview reports which components are on, in one call, rather than one failed request at a time.
That is a much bigger deal on BuddyBoss than on most plugins. Messages, groups, forums, media, documents, connections, profile fields — each is a component that can be off, and a site running a fraction of them is normal rather than unusual.
So an ability failing because its component is inactive is the most common failure in this suite, and one overview call converts it from a series of surprises into a known map.
The permissions section matters for the same reason. Several abilities here cross privacy boundaries — reading another member’s messages, changing their notification state — and they work because administrators hold bp_moderate. Knowing that in advance is better than discovering it mid-task.
Settings are read-only here by design: writing them could disable the very REST switches these abilities depend on, which would be a call that removes the ability to undo itself.
Narrow with sections when you only need part of it.
Input
| Name | Type | Required | What it is |
|---|---|---|---|
sections | array | No | Only return these sections of the overview. |
What comes back
| Name | Type | What it is |
|---|---|---|
components | object | Which components are active. |
size | object | Members, groups and activity counts. |
settings | object | Site-wide community settings. Read-only. |
permissions | object | What the current user may do. |
success | boolean | Whether the call completed. |
message | string | A one-line summary of what happened, suitable for showing a human. |
error_code | string | Present only on failure — a stable machine-readable reason, such as a missing field, a wrong field type or an unmet confirmation. |
Example
Ask your assistant:
What does this BuddyBoss community have switched on?
It resolves to one call:
{
"ability": "buddyboss/get-community-overview",
"parameters": {}
}Worth knowing
- Two thirds of this suite is typically unreachable. This says which.
- An inactive component is the most common cause of a failure here.
- Settings are deliberately read-only — writing them could break REST access.
- Read-only.
Related abilities
- BuddyBoss Get Community Report — the numbers in detail
- BuddyBoss List Community Taxonomies — the slugs other abilities accept
- BuddyBoss Search Community — find something across components
Get the plugins:
AcrossAI Abilities Manager · AcrossAI MCP Manager
Browse the rest: Every ability, by category