Returns one course in its editable form, with the lock screen configuration, the attached category ids and — when it has students — the completion count and average progress.

Endpoint

• Method: GET

• Path: /admin/courses/{course_id}

• Edition: Core

• Controller: CourseAdminController@findCourse

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

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

• Requires a course admin for this course, or a WordPress user with manage_options.

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 Admin Course

GET

/admin/courses/{course_id}

Returns one course in its editable form, with the lock screen configuration, the attached category ids and — when it has students — the completion count and average progress.

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

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

Responses

Successful response

Content-Type

application/json

{

  

"course": {

  

  

"category_ids": [

  

  

  

{

  

  

  

  

"additionalProperties": "string"

  

  

  

}

  

  

],

  

  

"completed_students": 0,

  

  

"course_type": "string",

  

  

"cover_photo": "string",

  

  

"created_at": "string",

  

  

"created_by": "string",

  

  

"description": "string",

  

  

"id": 0,

  

  

"lockscreen": [

  

  

  

{

  

  

  

  

"background_image": "string",

  

  

  

  

"button_color": "string",

  

  

  

  

"button_link": "string",

  

  

  

  

"button_text": "string",

  

  

  

  

"button_text_color": "string",

  

  

  

  

"description": "string",

  

  

  

  

"heading": "string",

  

  

  

  

"heading_color": "string",

  

  

  

  

"hidden": true,

  

  

  

  

"label": "string",

  

  

  

  

"name": "string",

  

  

  

  

"new_tab": "string",

  

  

  

  

"overlay_color": "string",

  

  

  

  

"text_color": "string",

  

  

  

  

"type": "string"

  

  

  

}

  

  

],

  

  

"logo": "string",

  

  

"overAllProgress": 0,

  

  

"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",

  

  

"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"

  

}

}

GET

/admin/courses/{course_id}

Playground

Authorization

ApplicationPasswords

Variables

Key

Value

course_id*

Samples

Powered by VitePress OpenAPI