Search Potential Members for The Course
Developing
GET
/courses/{courseId}/members/potential
role
.role
: The role of the member inside the coursecourseId
: Course Id from which the list of members will be returnedRequest Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.aladia.io/v2/courses//members/potential?role=course-teacher&limit=50&next=&prev=&sortBy=&sortDirection=asc' \
--header 'apikey: '
Response Response Example
{
"data": [
{
"id": "64fa79fe6d364f0eabe4574e",
"picture": "https://loremflickr.com/640/480",
"firstName": "Kylee",
"lastName": "Nolan",
"name": "Sherri Stiedemann"
}
],
"cursor": {
"next": null,
"prev": null,
"totalItems": 1
}
}
Request
Path Params
courseId
stringÂ
required
Query Params
role
stringÂ
optional
Example:
course-teacher
limit
integerÂ
optional
Default:
50
next
stringÂ
optional
prev
stringÂ
optional
sortBy
stringÂ
optional
sortDirection
enum<string>Â
optional
Allowed values:
ascdesc
Default:
asc
Header Params
apikey
stringÂ
optional
Example:
{{apikey}}
Responses
Modified at 2025-04-08 15:39:29