Skip to content

Endpoint

  • Method: GET
  • Path: /admin/courses/{course_id}/users/search
  • Edition: Core
  • Controller: CourseAdminController@getOtherUsers
  • Route source: fluent-community/Modules/Course/Http/course_api.php:29
  • Controller source: fluent-community/Modules/Course/Http/Controllers/CourseAdminController.php

GET Search Course Users

GET
/admin/courses/{course_id}/users/search

Search Course Users for the FluentCommunity Courses API.

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

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 getOtherUsers().

Type
string

Responses

Successful response

application/json
JSON
{
  
"users": {
  
  
"data": [
  
  
  
{
  
  
  
  
"id": 0
  
  
  
}
  
  
],
  
  
"current_page": 0,
  
  
"per_page": 0,
  
  
"from": 0,
  
  
"to": 0,
  
  
"total": 0,
  
  
"last_page": 0,
  
  
"has_more": true
  
}
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation