Returns a flattened, spreadsheet-shaped list of a course roster — name, email, username, progress percentage, enrolment date and last activity.
Capped at 5000 students in a single call and filterable with search. Progress is calculated in bulk for the whole page rather than per student.
Endpoint
Method:
GETPath:
/admin/courses/{course_id}/export/studentsEdition: PRO
Controller:
ProAdminController@getExportableStudentsRoute source:
fluent-community-pro/app/Http/Routes/api.php:27Controller source:
fluent-community-pro/app/Http/Controllers/ProAdminController.phpRequires a course admin for this course, or a WordPress user with
manage_options.Requires FluentCommunity Pro.
The response includes member email addresses.
Live sample
The request and response below were recorded against a running FluentCommunity install and then anonymised — member names, emails, avatars and post content are fictional, and long collections are trimmed to a few entries.
GET Get Exportable Students
Returns a flattened, spreadsheet-shaped list of a course roster — name, email, username, progress percentage, enrolment date and last activity.
Controller: ProAdminController@getExportableStudents
Route source: fluent-community-pro/app/Http/Routes/api.php:27
Authorizations
WordPress Application Passwords — use Basic auth with username:application_password.
Parameters
Path Parameters
Course ID extracted from the URL path.
Query Parameters
Search read via $request->getSafe() in getExportableStudents().
Responses
Successful response