This document is generated by Aladia.

Search Potential Members for The Course

Developing

GET

/courses/{courseId}/members/potential

This endpoint returns only the profile members belonging to the specified Course, which also partially match the informed role.

Expected query parameters:

role: The role of the member inside the course

Expected path parameters:

courseId: Course Id from which the list of members will be returned

Returns:

An array of members object which partially match the query, containing their data and respective contextual role in this specific course inside the data property aswell as their paggination.

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

Query Params

Header Params

Responses

🟢200Success

application/json

Body

Modified at 2025-04-08 15:39:29

Search Member

Get Invitation