Search Members - Aladia API

This endpoint returns the profile members belonging to the specified space and other profiles that partially match the provided username.

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

Expected query parameters:

roles: The role to filter the space members

username: The username of the space member

alreadyMember: To filter members that have accepted an invitation or not.

courseId: The courseId that the license belongs to.

licensed: To filter members that have license or not, if not present it will return members regardless of license.

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/search?username=leul&roles=space-member, space-coordinator&alreadyMember=true&licensed&courseId=672d82ad1adbd4482345c9d8&limit=50&next=&prev=&sortBy=&sortDirection=asc' \ --header 'apikey: '

{ "data": [ { "id": "66d0233c1681058994bce488", "fullName": "Leul Ejigu", "picture": null, "role": "space-owner", "online": false } ], "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

username

string

optional

The username of the members

Example:

leul

roles

array[string]

optional

The roles separated by commas

Example:

space-member, space-coordinator

alreadyMember

boolean

optional

If the user accepted the invite or not

Example:

true

licensed

boolean

optional

courseId

string

optional

Example:

672d82ad1adbd4482345c9d8

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

cursor

object (cursor)

optional

The start date for the usage range [ISODate]

string | null

required

string | null

required

totalItems

integer

required

entities

array[object (member.rto) {10}]

optional

The end date for the usage range [ISODate]

string

optional

The start date for the usage range [ISODate]

fullName

string

optional

The end date for the usage range [ISODate]

picture

string

optional

Usage results as array of measurements

role

string

optional

group

string

optional

online

boolean

optional

invited

boolean

optional

invitedAt

string

optional

lastActivity

string

optional

invitationStatus

string

optional

🟠404Record Not Found

🟠401Unauthorized