This document is generated by Aladia.

Search Member

Developing

GET

/courses/{courseId}/members/search

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

Expected query parameters:

roles: The roles of the course members to filter by.

username: The name of the course member to be searched, an optional query param.

type: The type of the member to be searched, an optional query param.

purchased: A boolean value to fetch members who purchased 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/search?roles=course-teacher, course-attendant&username&type=profile&cycle=&purchased&limit=50&next=&prev=&sortBy=&sortDirection=asc' \
--header 'apikey: '

Response Example

200 - Success

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

🟠401Unauthorized

🟠403Forbidden

🟠422Parameter Error

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

Update Member

Search Potential Members for The Course