Skip to content

Returns the paginated list of courses the current user may manage, each with its student count and its section and lesson totals.

Unlike the portal listing this includes drafts. Filter with search, topic_slug and status (published or draft); sort with sort_by=alphabetical, otherwise newest first. Pass with_categories to receive the category list too.

Endpoint

  • Method: GET

  • Path: /admin/courses

  • Edition: Core

  • Controller: CourseAdminController@getCourses

  • Route source: fluent-community/Modules/Course/Http/course_api.php:22

  • Controller source: fluent-community/Modules/Course/Http/Controllers/CourseAdminController.php

  • Requires the course-creator permission; the list is scoped to courses the caller administers.

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 List Admin Courses

GET
/admin/courses

Returns the paginated list of courses the current user may manage, each with its student count and its section and lesson totals.

Controller: CourseAdminController@getCourses
Route source: fluent-community/Modules/Course/Http/course_api.php:22

Authorizations

ApplicationPasswords

WordPress Application Passwords — use Basic auth with username:application_password.

Type
API Key (header: Authorization)

Parameters

Query Parameters

status

Status read via $request->getSafe() in getCourses().

Type
string
sort_by

Sort By read via $request->getSafe() in getCourses().

Type
string
Default
"latest"
topic_slug

Topic Slug read via $request->getSafe() in getCourses().

Type
string
search

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

Type
string
with_categories

With Categories read via $request->get() in getCourses().

Type
string

Responses

Successful response

application/json
JSON
{
  
"course_categories": [
  
  
{
  
  
  
"additionalProperties": "string"
  
  
}
  
],
  
"courses": {
  
  
"current_page": 0,
  
  
"data": [
  
  
  
{
  
  
  
  
"cover_photo": "string",
  
  
  
  
"created_at": "string",
  
  
  
  
"created_by": "string",
  
  
  
  
"description": "string",
  
  
  
  
"id": 0,
  
  
  
  
"lessonsCount": 0,
  
  
  
  
"logo": "string",
  
  
  
  
"owner": {
  
  
  
  
  
"ID": 0,
  
  
  
  
  
"display_name": "string",
  
  
  
  
  
"photo": "string",
  
  
  
  
  
"user_email": "string",
  
  
  
  
  
"user_login": "string",
  
  
  
  
  
"user_nicename": "string",
  
  
  
  
  
"user_registered": "string",
  
  
  
  
  
"user_status": "string",
  
  
  
  
  
"user_url": "string"
  
  
  
  
},
  
  
  
  
"parent_id": "string",
  
  
  
  
"privacy": "string",
  
  
  
  
"sectionsCount": 0,
  
  
  
  
"serial": "string",
  
  
  
  
"settings": {
  
  
  
  
  
"can_request_join": "string",
  
  
  
  
  
"course_details": "string",
  
  
  
  
  
"course_layout": "string",
  
  
  
  
  
"course_type": "string",
  
  
  
  
  
"custom_lock_screen": "string",
  
  
  
  
  
"disable_comments": "string",
  
  
  
  
  
"emoji": "string",
  
  
  
  
  
"hide_instructor_view": "string",
  
  
  
  
  
"hide_members_count": "string",
  
  
  
  
  
"layout_style": "string",
  
  
  
  
  
"links": [
  
  
  
  
  
  
{
  
  
  
  
  
  
  
"additionalProperties": "string"
  
  
  
  
  
  
}
  
  
  
  
  
],
  
  
  
  
  
"members_page_status": "string",
  
  
  
  
  
"og_image": "string",
  
  
  
  
  
"public_lesson_view": "string",
  
  
  
  
  
"restricted_post_only": "string",
  
  
  
  
  
"sequential_lesson_order": "string",
  
  
  
  
  
"shape_svg": "string",
  
  
  
  
  
"show_instructor_students_count": "string",
  
  
  
  
  
"show_sidebar": "string",
  
  
  
  
  
"topic_required": "string"
  
  
  
  
},
  
  
  
  
"slug": "string",
  
  
  
  
"status": "string",
  
  
  
  
"students_count": 0,
  
  
  
  
"title": "string",
  
  
  
  
"type": "string",
  
  
  
  
"updated_at": "string"
  
  
  
}
  
  
],
  
  
"first_page_url": "string",
  
  
"from": 0,
  
  
"last_page": 0,
  
  
"last_page_url": "string",
  
  
"links": [
  
  
  
{
  
  
  
  
"active": true,
  
  
  
  
"label": "string",
  
  
  
  
"url": "string"
  
  
  
}
  
  
],
  
  
"next_page_url": "string",
  
  
"path": "string",
  
  
"per_page": 0,
  
  
"prev_page_url": "string",
  
  
"to": 0,
  
  
"total": 0
  
}
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation