This document is generated by Aladia.

Search Members

Testing

GET

/calendars/{calendarId}/members/search

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

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

Expected query parameters:

roles: The role to filter the calendar members. eg. Owner, Organizer, Scheduler, and Participant.

Expected path parameters:

calendarId: Calendar 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 calendar inside the data property as well as their pagination.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.aladia.io/v2/calendars/66df1b60c9b61c08ddb0d380/members/search?roles=Organizer, Participant, Scheduler, Owner, &limit=50&next=&prev=&sortBy=&sortDirection=asc&query=' \
--header 'apikey: '

Response Example

200 - Success

{
    "data": [
        {
            "fullName": "Tamirat Dereje",
            "id": "66e19776c386d04f46720264",
            "picture": null,
            "role": "Scheduler",
            "online": false,
            "email": "tamirat.dereje@aladia.io",
            "invited": false,
            "invitedAt": "Tue Sep 24 2024 09:09:31 GMT+0300 (East Africa Time)",
            "lastActivity": "Wed Sep 11 2024 16:13:31 GMT+0300 (East Africa Time)"
        },
        {
            "fullName": "Daniel Dereje",
            "id": "66e19785c386d04f4672028e",
            "picture": null,
            "role": "Organizer",
            "online": false,
            "email": "daniel.dereje@aladia.io",
            "invited": false,
            "invitedAt": "Tue Sep 24 2024 09:09:31 GMT+0300 (East Africa Time)",
            "lastActivity": "Wed Sep 11 2024 16:13:43 GMT+0300 (East Africa Time)"
        },
        {
            "fullName": null,
            "id": null,
            "picture": null,
            "role": "Participant",
            "online": null,
            "email": null,
            "invited": true,
            "invitedAt": "Tue Sep 24 2024 09:09:49 GMT+0300 (East Africa Time)",
            "lastActivity": null
        },
        {
            "fullName": "Tamirat Dereje",
            "id": "66e19776c386d04f46720264",
            "picture": null,
            "role": "Scheduler",
            "online": false,
            "email": "tamirat.dereje@aladia.io",
            "invited": true,
            "invitedAt": "Tue Sep 24 2024 09:09:49 GMT+0300 (East Africa Time)",
            "lastActivity": "Wed Sep 11 2024 16:13:31 GMT+0300 (East Africa Time)"
        }
    ],
    "cursor": {
        "next": null,
        "prev": null,
        "totalItems": 4
    }
}

Request

Path Params

Query Params

Header Params

Responses

🟢200OK

application/json

Body

🟠401Unauthorized

🟠403Forbidden

Modified at 2025-04-09 12:47:02

Retrieve All Members

Get Invitation Link