Search Members - Aladia API

This endpoint returns the profile members belonging to the specified Event.

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

Expected query parameters:

roles: The role to filter the event members. eg. guest, and co-host.

Expected path parameters:

eventId: Event 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 event inside the data property as well as their pagination.

curl --location --request GET 'https://api.aladia.io/v2/calendars/66df1b60c9b61c08ddb0d380/events/66f636885550f70db3874945/members/search?roles=host,guest,co-host&limit=50&next=&prev=&sortBy=&sortDirection=asc&query=' \ --header 'apikey: '

{ "data": [ { "fullName": "Tamirat Dereje", "id": "66e19776c386d04f46720264", "picture": null, "role": "guest", "online": false, "email": "tamirat.dereje@aladia.io", "invited": false, "invitedAt": "Tue Oct 01 2024 11:54:04 GMT+0300 (East Africa Time)", "lastActivity": "Wed Sep 11 2024 16:13:31 GMT+0300 (East Africa Time)", "invitationStatus": null }, { "fullName": "Daniel Dereje", "id": "66e19785c386d04f4672028e", "picture": null, "role": "co-host", "online": false, "email": "daniel.dereje@aladia.io", "invited": false, "invitedAt": "Tue Oct 01 2024 11:55:22 GMT+0300 (East Africa Time)", "lastActivity": "Wed Sep 11 2024 16:13:43 GMT+0300 (East Africa Time)", "invitationStatus": null } ], "cursor": { "next": null, "prev": null, "totalItems": 2 } }

Request

Path Params

calendarId

string

required

Example:

66df1b60c9b61c08ddb0d380

eventId

string

required

Example:

66f636885550f70db3874945

Query Params

roles

array[string]

optional

Example:

["host,guest,co-host"]

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

query

string

optional

The search query string.

Header Params

apikey

string

optional

Example:

Responses

🟢200OK

application/json

Body

data

array [object {9}]

required

fullName

string | null

required

string | null

required

picture

string | null

optional

role

string

required

online

boolean | null

required

string | null

required

invited

boolean

required

invitedAt

string | null

optional

lastActivity

string | null

optional

cursor

object

required

string | null

optional

string | null

optional

totalItems

integer | null

optional

🟠401Unauthorized

🟠403Forbidden