Search Potential Members

This endpoint returns the profile members belonging to the specified space who can assume the role specified by courseRole, as well as the course members who currently have 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.

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

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

Request

Path Params

spaceId

string

required

Space Id from which the list of members will be returned

Example:

66479aa5905bfd0cb5377619

Query Params

courseId

string

optional

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

Example:

66479aa5905bfd0cb5377619

username

string

optional

The username of the member

Example:

paulo

limit

integer

optional

Number of documents per page in the response

Default:

string

optional

Next token cursor, to navigate towards the next page

string

optional

Previous token cursor, to navigate towards the previous page

sortBy

string

optional

Optional field to be used as a sorting reference

sortDirection

enum<string>

optional

Set the results in ascending (asc) or descending (desc) direction

Allowed values:

ascdesc

Default:

asc

Header Params

apikey

string

optional

Example:

Responses

🟢200Success

application/json

Body

data

array[object (Potential-member.rto) {6}]

required

string

required

The start date for the usage range [ISODate]

fullName

string

required

The end date for the usage range [ISODate]

picture

string | null

required

Usage results as array of measurements

online

boolean

required

lastActivity

string | null

optional

spaceRole

string | null

optional

🟠404Record Not Found

🟠401Unauthorized