learndash/get-group fetches a single group: its post fields, its LearnDash settings, the courses it grants, and counts of its members and leaders.
The course list is the part that matters for access.
At a glance
| Ability | learndash/get-group |
| 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
Everything a group grants comes from that list. Adding a course to it grants that course to every member at once; removing one revokes it from every member at once.
So the list is the group’s reach, and the member count is its scale. The two together are what any decision about the group depends on.
The settings mirror a course’s in shape. group_price_type and group_price make a group purchasable, which is how LearnDash sells course bundles, and certificate names a template issued on completing the group.
group_courses_auto_enroll decides whether joining the group enrols members in its courses automatically or merely grants access.
Counts rather than lists, because a group with several hundred members is common and the detail is a separate call.
Input
| Name | Type | Required | What it is |
|---|---|---|---|
group_id | integer | Yes | The group. |
What comes back
| Name | Type | What it is |
|---|---|---|
group | object | Post fields and LearnDash settings. |
courses | array | The courses this group grants. |
member_count | integer | How many members. |
leader_count | integer | How many leaders. |
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 group give people access to?
It resolves to one call:
{
"ability": "learndash/get-group",
"parameters": {
"group_id": 700
}
}Worth knowing
- The course list is the group’s entire reach.
- A group can be sold, which is how course bundles work.
- Auto-enrol decides between enrolment and mere access.
- Read-only.
Related abilities
- LearnDash Manage Group Courses — change what it grants
- LearnDash List Group Members — who would be affected
- LearnDash Manage Group — change the settings
Get the plugins:
AcrossAI Abilities Manager · AcrossAI MCP Manager
Browse the rest: Every ability, by category