learndash/list-groups lists LearnDash groups, with keyword search, status and author filters, sorting and paging.
A group bundles learners together and assigns them a set of courses at once.
At a glance
| Ability | learndash/list-groups |
| Toolset | LearnDash — toolset/learndash |
| Group | LearnDash › Groups |
| Requires | AcrossAI Pro, plus LearnDash LMS 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
Groups are how LearnDash handles cohorts, organisations and anything else where the same set of people should get the same set of courses.
The mechanism is indirect and worth understanding: a group grants courses, and membership of the group grants those courses to the member. Nobody is enrolled in the course directly.
That indirection is why learndash/get-access-info distinguishes access via a group from direct enrolment, and why unenrolling somebody from a course does nothing when a group is granting it.
Groups can have leaders, who manage the group and can see their members’ reporting. What a leader may actually do is settings-driven rather than fixed by the role.
learndash/get-group is one group in detail, learndash/list-group-members is who is in it, and learndash/manage-group-courses is what it grants.
Input
| Name | Type | Required | What it is |
|---|---|---|---|
search | string | No | Keyword search. |
status | string | No | Post status filter. |
author | integer | No | Only groups owned by this user. |
per_page | integer | No | Rows per page. |
What comes back
| Name | Type | What it is |
|---|---|---|
groups | array | Each group with its ID, title, status and author. |
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 groups does this site have?
It resolves to one call:
{
"ability": "learndash/list-groups",
"parameters": {}
}Worth knowing
- Access through a group is not direct enrolment, and behaves differently.
- A group grants courses; membership passes them on.
- What a leader may do is settings-driven, not fixed by the role.
- Read-only.
Related abilities
- LearnDash Get Group — one group in detail
- LearnDash Manage Group Courses — what it grants
- LearnDash List Group Members — who is in it
Get the plugins:
AcrossAI Abilities Manager · AcrossAI MCP Manager
Browse the rest: Every ability, by category