Endpoint
- Method:
GET - Path:
/courses - Edition: Core
- Controller:
CourseController@getCourses - Route source:
fluent-community/Modules/Course/Http/course_api.php:8 - Controller source:
fluent-community/Modules/Course/Http/Controllers/CourseController.php
GET List Courses
GET
/courses
List Courses for the FluentCommunity Courses API.
Controller: CourseController@getCourses
Route source: fluent-community/Modules/Course/Http/course_api.php:8
Authorizations
ApplicationPasswords
WordPress Application Passwords — use Basic auth with username:application_password.
Type
API Key (header: Authorization)
Parameters
Query Parameters
search
Search read via $request->getSafe() in getCourses().
Type
string
topic_slug
Topic Slug read via $request->getSafe() in getCourses().
Type
string
type
Type read via $request->getSafe() in getCourses().
Type
string
sort_by
Sort By read via $request->getSafe() in getCourses().
Type
string
Default
"alphabetical"with_categories
With Categories read via $request->get() in getCourses().
Type
string
Responses
Successful response
application/json
JSON "courses": { "data": [ { "id": 0 } ], "current_page": 0, "per_page": 0, "from": 0, "to": 0, "total": 0, "last_page": 0, "has_more": true }, "course_categories": [ { "additionalProperties": "string" } ]
{
}