buddyboss/search-recipients searches for members who are able to receive a private message.
That set is narrower than the member directory, and the difference is the point.
At a glance
| Ability | buddyboss/search-recipients |
| Toolset | BuddyBoss — toolset/buddyboss |
| Group | BuddyBoss › Messages |
| Requires | AcrossAI Pro, plus BuddyBoss Platform active on the site |
| Capability | manage_options |
| Safety | Writes data |
| Repeatable | Idempotent — running it twice leaves the same result |
| Ships in | AcrossAI Pro 0.9.16 and later |
How it works
A site can restrict messaging to connections, or to members of shared groups. Individual members can narrow it further in their own settings. And blocks are honoured.
So somebody buddyboss/list-members returns may simply be unreachable, and a message to them will not arrive.
Using this before buddyboss/send-message does two things: it resolves names to IDs, and it establishes in advance whether the message can be delivered at all.
That second part is what makes it worth the call. A send that silently fails to reach somebody is worse than a send that is refused, and this turns the first into the second.
It is idempotent and read-like in effect, though not annotated read-only because it evaluates permissions rather than simply listing records.
Input
| Name | Type | Required | What it is |
|---|---|---|---|
search | string | Yes | The name to search for. |
sender_id | integer | No | Evaluate reachability from this member’s perspective rather than the caller’s. |
What comes back
| Name | Type | What it is |
|---|---|---|
recipients | array | Members who can receive a message, with their IDs. |
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:
Can I message this person?
It resolves to one call:
{
"ability": "buddyboss/search-recipients",
"parameters": {
"search": "sam"
}
}Worth knowing
- Narrower than the member directory, by design.
- Messaging can be restricted site-wide, per member, and by blocks.
- Turns a silent delivery failure into an answer before sending.
- Idempotent.
Related abilities
- BuddyBoss Send Message — what this precedes
- BuddyBoss Get Account Settings — their own messaging rules
Get the plugins:
AcrossAI Abilities Manager · AcrossAI MCP Manager
Browse the rest: Every ability, by category