Endpoint

• Method: GET
• Path: /admin/courses/{course_id}/export/students
• Edition: PRO
• Controller: ProAdminController@getExportableStudents
• Route source: fluent-community-pro/app/Http/Routes/api.php:27
• Controller source: fluent-community-pro/app/Http/Controllers/ProAdminController.php

GET Get Get Exportable Students

GET

/admin/courses/{course_id}/export/students

Get Get Exportable Students for the FluentCommunity Admin API.

Controller: ProAdminController@getExportableStudents
Route source: fluent-community-pro/app/Http/Routes/api.php:27

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

integer

Required

Query Parameters

search

Search read via $request->getSafe() in getExportableStudents().

Type

string

Responses

Successful response

Content-Type

application/json

{

  

"students": [

  

  

{

  

  

  

"additionalProperties": "string"

  

  

}

  

]

}

GET

/admin/courses/{course_id}/export/students

Playground

Authorization

ApplicationPasswords

Variables

Key

Value

course_id*

search

Samples

Powered by VitePress OpenAPI