This document is generated by Aladia.

Search Potential Members

Testing

GET

/spaces/{spaceId}/members/potential

Returns the profile members belonging to the specified Space that can become the role specified on the courseRole and the course members that has this courseRole.

As in other endpoints, all users are returned with their contextual roles in this specific space and course.

Expected query parameters:

courseId: The id of the course that you want to list the potential members of.

username: The username of the member.

Expected path parameters:

spaceId: Space 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 space inside the data property aswell as their paggination.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.aladia.io/v2/spaces/66479aa5905bfd0cb5377619/members/potential?courseId=66479aa5905bfd0cb5377619&username=paulo&limit=50&next=&prev=&sortBy=&sortDirection=asc' \
--header 'apikey: '

Response Example

200 - Success

{
    "data": [
        {
            "id": "6654496d6ff90ca9d3cad033",
            "fullName": "Leul Ejigu",
            "picture": null,
            "courseRole": "course-teacher",
            "spaceRole": null
        }
    ],
    "cursor": {
        "next": null,
        "prev": null,
        "totalItems": 1
    }
}

Request

Path Params

Query Params

Header Params

Responses

🟢200Success

application/json

Body

🟠404Record Not Found

🟠401Unauthorized

Modified at 2025-04-08 10:39:38

Search Members

Add a Member