LearnDashInstall

Summary

Retrieve a paginated list of LearnDash Groups filtered and sorted according to specified criteria.

Inputs

• Filters — Optional filters to control the list of groups returned. Includes parameters such as 'Search' (string to search group titles), 'Per Page' (number of groups per page, 1-100, default 50), 'Page' (page number, minimum 1, default 1), 'Order' (sorting order, ascending or descending, default ascending), 'Order By' (field by which to order results, e.g., date, id, title, default date), and 'Status' (post status filter, e.g., publish, draft, default any).
• Query Parameters (JSON) — Optional advanced filter parameters as a JSON string to add custom query string parameters beyond the available Filters collection. Leave blank if not needed.

Output shape

a list of group items matching the filters, each item representing a LearnDash Group object as returned by the LearnDash API.

Pagination is controlled by the 'Per Page' and 'Page' filter parameters. If no filters are specified, the operation returns the first 50 groups sorted by date ascending. The output is an array of JSON objects, each one corresponding to a group. Errors in JSON format fields will cause operation errors.

Examples

Example 1: List the first 20 published groups with titles matching 'math' sorted descending by title.

Set Filters > Search to 'math', Per Page to 20, Order to DESC, Order By to Title, and Status to Publish.