LearnDashInstall

Summary

List users related to a specific LearnDash course, filtered and paginated according to parameters.

Inputs

• Parent ID (required) — The ID of the parent resource, typically a Course, Group, or User, to list related course users from.
• Filters — Optional collection of filters to refine the results, including search text, pagination (page number and items per page), ordering, order by field, and user status.
• Query Parameters (JSON) — Optional advanced query parameters as a JSON object, allowing additional filtering beyond the standard filters.

Output shape

a list of user objects related to the specified parent course or group

The results are paginated according to 'Per Page' and 'Page' filters; the output returns an array of users matching the given filters and parent ID. If no users match, an empty array is returned.

Examples

Example 1: Retrieve the first 50 users enrolled in a LearnDash course with ID '123', filtered to published status and ordered ascending by date.

Set Parent ID to '123'. Under Filters, set Status to 'Publish', Per Page to 50, Page to 1, Order to 'ASC', and Order By to 'Date'.