Skip to main content

Get Course Users Waiting Approval

This endpoint retrieves the list of all the users waiting to be accepted to join the course identified by {id}.

info

This operation requires the course creator or manager role.

HTTP Request

GET /api/v2/course/{id}/request_join/

Parameters

NameInTypeRequiredDescription
idpathstringtrueA unique integer value identifying this course
limitqueryintegerfalseNumber of results to return per page
offsetqueryintegerfalseThe initial index from which to return the results
searchquerystringfalseA search term (search inside username and real_name of the users)

Example Request

const headers = {
'Accept':'application/json',
'Authorization: Bearer <token>'
};

fetch('/api/v2/course/{id}/request_join/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});

Responses

StatusMeaningDescriptionSchema
200OKResponse status codeInline

Response Schema

Status Code 200

NameTypeRequiredRestrictionsDescription
» countintegerfalsenoneTotal results count
» nextstring(uri)¦nullfalsenoneNext page url
» previousstring(uri)¦nullfalsenonePrevious page url
» resultslist(User)falsenoneList of users