This document is generated by Aladia.

Search Events

Testing

GET

/calendars/{calendarId}/events/search

The "search even based on either name ,startdate, enddate " endpoint enables users to query the system for events matching a specific name, date ,facilitating efficient retrieval of event by query param.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.aladia.io/v2/calendars//events/search?name&startDate&endDate&cycleId&limit=50' \
--header 'apikey: '

Response Example

200 - Success

{
  "data": [
    {
      "id": "66f536b8b9d5fe5295e3281c",
      "calendarId": "66f5352830bb1fffc4c2cb7c",
      "name": "morning test",
      "dates": {
        "startDate": "2024-10-09T05:45:00.000Z",
        "endDate": "2024-10-09T06:00:00.000Z"
      },
      "membersCount": 1,
      "ownerProfilePicture": null
    },
    {
      "id": "66f536b9b9d5fe5295e3281f",
      "calendarId": "66f5352830bb1fffc4c2cb7c",
      "name": "morning test",
      "dates": {
        "startDate": "2024-10-10T05:45:00.000Z",
        "endDate": "2024-10-10T06:00:00.000Z"
      },
      "membersCount": 1,
      "ownerProfilePicture": null
    },
    {
      "id": "66f536b9b9d5fe5295e32822",
      "calendarId": "66f5352830bb1fffc4c2cb7c",
      "name": "morning test",
      "dates": {
        "startDate": "2024-10-11T05:45:00.000Z",
        "endDate": "2024-10-11T06:00:00.000Z"
      },
      "membersCount": 1,
      "ownerProfilePicture": null
    },
    {
      "id": "66f536b9b9d5fe5295e32825",
      "calendarId": "66f5352830bb1fffc4c2cb7c",
      "name": "morning test",
      "dates": {
        "startDate": "2024-10-12T05:45:00.000Z",
        "endDate": "2024-10-12T06:00:00.000Z"
      },
      "membersCount": 1,
      "ownerProfilePicture": null
    }
  ],
  "cursor": {
    "next": null,
    "prev": null,
    "totalItems": 4
  }
}

Request

Path Params

calendarId

string

required

Query Params

name

string

optional

name

startDate

string | null

optional

start date of the event

endDate

string | null

optional

end date of the event

cycleId

string

optional

limit

integer

optional

Number of documents per page in the response

Default:

Header Params

apikey

string

optional

Example:

Responses

🟢200Success

application/json

Body

data

array [object {8}] | null

optional

string

required

calendarId

string

required

name

string

required

dates

object

required

roomStatus

string | null

optional

ownerProfilePicture

string | null

optional

membersIds

array[string] | null

optional

entityType

string | null

optional

cursor

object | null

optional

string | null

optional

string | null

optional

totalItems

integer

required

🟠401Unauthorized

🟠403Forbidden

Modified at 2025-03-28 12:34:17

Delete an Event

Get Auth Token