LearnDash icon

LearnDash

Interact with the LearnDash LMS REST API

Actions60

Assignments → List

AI-generated

Summary

Retrieve a list of LearnDash assignments with optional filtering, pagination, and sorting controls.

Inputs

  • Filters — Optional filters to refine the list of assignments returned. Includes parameters for search text, pagination (perPage and page), order (ascending or descending), order by specific fields (date, ID, include, menu order, slug, title), and status (draft, pending, private, publish, trash, or any).
  • Query Parameters (JSON) — Optional JSON-formatted string to provide advanced query parameters not covered by the standard filters. Must be a valid JSON object representing query string parameters.

Output shape

a list of assignment records as JSON objects

The operation returns an array of assignment objects matching the specified filters and query parameters. Pagination controls determine how many items are returned per page and which page of results is retrieved. If no filters or query parameters are specified, a default list of assignments up to 50 per page is returned.

Examples

Example 1: List all published assignments, 20 per page, on page 2, ordered descending by date.

Set Filters to Status='Publish', Per Page=20, Page=2, Order='DESC', Order By='Date'. Leave Query Parameters empty.

Discussion