Search Member - Aladia API

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.

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

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

roles

string

required

The roles of the course members to filter by

Example:

course-teacher, course-attendant

username

string

optional

The name of a course member to filter

type

string

optional

The type of the course member to search by

Example:

profile

cycle

string

optional

To search a member in a specific cycle on live course

purchased

boolean

optional

Search Members that only purchased the course

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 (member-gateway.rto) {11}]

optional

string | null

optional

user id

fullName

string | null

optional

user full name

picture

string | null

optional

user image

role

string | null

optional

user role

online

boolean | null

optional

user online status

lastActivity

string | null

optional

user last activity date

story

object | null

optional

string | null

optional

user email

invited

boolean | null

optional

user invited status

invitedAt

string | null

optional

user invited date

expiresAt

string | null

optional

user invitation expire date

string

required

string

required

totalItems

integer

required

🟠401Unauthorized

🟠403Forbidden

🟠422Parameter Error