Skip to main content
type: QUERY_EXPORT_TYPE_SCHOOL_STUDENT_FIND_MANY Exports the school’s students through their course accesses: course progress, groups, curator, tariff and access status (one student = one product access). This is a report type for the query-export/generate method: pass it in the type field, and pass the filter and sorting in variables.
Students are exported from product accesses (productAccessManageFindMany): one student = one course access. That is why variables is the access filter and sorting (FilterAccessProductInput / SortAccessProductInput), the same structure as in the “Access billing” report. An unknown field or an invalid value is not ignored: the export finishes with status: Failed.

Variables (variables)

object
required
Access filter parameters. Required: to export all records without filtering, pass an empty object {}.
object
Sorting parameters. Values: ASC (ascending) or DESC (descending).

Report columns

SchoolStudents sheet: User ID, Full name, Login method, Course ID, Course name, Group ID, Group, Curator, Current lesson, Progress (%), Completed lessons, Total lessons, Date added, Access expiration date, Tariff ID, Tariff. With a non-empty filter.product.productIds, “Last activity” and “Access status” are added. Corporate schools do not have the “Tariff ID” and “Tariff” columns. In XLSX format only, if the export contains bundles, a Course Progress sheet is generated with a breakdown of progress by the bundle’s nested courses: User ID, Full name, Bundle ID, Bundle name, Course ID, Course name, Progress (%), Completed lessons, Total lessons, Current lesson. Column names are given as they appear without the Ux-Language header (in English); with the header, they are translated into the specified language (see the generate description for details).
The method’s response is a generation task with a uuid. Get the file via result retrieval.

Permission requirements

Requires token authentication and one of the permissions: “School User Management” (SchoolManageUsers) or “Course Student Management” (CourseStudentManage). Without the permission, the generation request succeeds, but the export finishes with status: Failed.

Updated: 2026-09-25 14:33 UTC