Endpoint
- Method:
GET - Path:
/admin/courses/{course_id}/students - Edition: Core
- Controller:
CourseAdminController@getCourseStudents - Route source:
fluent-community/Modules/Course/Http/course_api.php:25 - Controller source:
fluent-community/Modules/Course/Http/Controllers/CourseAdminController.php
GET List Course Students
GET
/admin/courses/{course_id}/students
List Course Students for the FluentCommunity Courses API.
Controller: CourseAdminController@getCourseStudents
Route source: fluent-community/Modules/Course/Http/course_api.php:25
Authorizations
ApplicationPasswords
WordPress Application Passwords — use Basic auth with username:application_password.
Type
API Key (header: Authorization)
Parameters
Path Parameters
course_id*
Course ID extracted from the URL path.
Type
Requiredinteger
Query Parameters
search
Search read via $request->getSafe() in getCourseStudents().
Type
string
Responses
Successful response
application/json
JSON "students": { "data": [ { "user_id": 0, "display_name": "string", "username": "string", "avatar": "string", "status": "string", "total_points": 0, "is_verified": true, "meta": { "website": "string", "cover_photo": "string", "badge_slug": [ "string" ], "social_links": { "instagram": "string", "twitter": "string", "youtube": "string", "linkedin": "string", "fb": "string", "blue_sky": "string", "tiktok": "string", "pinterest": "string", "telegram": "string", "snapchat": "string", "reddit": "string", "twitch": "string", "vk": "string", "github": "string", "mastodon": "string" } }, "created_at": "string", "short_description": "string", "last_activity": "string", "badge": "string", "permalink": "string" } ], "current_page": 0, "per_page": 0, "from": 0, "to": 0, "total": 0, "last_page": 0, "has_more": true }
{
}