This document is generated by Aladia.

Search Calendars

Testing

GET

/calendars/search

The "Search Calendar Based on Name" endpoint allows users to query the system for calendars that match a specific name. This facilitates efficient retrieval of calendars by their names, helping users quickly find the calendars they are looking for.

Request Parameters
name (required, string): The name of the calendar to search for. This can be a partial or full name.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.aladia.io/v2/calendars/search?name=&limit=50&next=&prev=&sortBy=&sortDirection=asc' \
--header 'apikey: '

Response Example

200 - Success

{
  "data": [
    {
      "id": "66fba5afd195e04a6f6137ec",
      "owner": {
        "id": "66fba5a3d195e04a6f6137e3",
        "type": "profile"
      },
      "entityId": null,
      "entityType": null,
      "name": "user001last",
      "type": null,
      "color": "#7F7309",
      "eventDuration": null,
      "schedule": null,
      "createdAt": "Tue Oct 01 2024 10:33:03 GMT+0300 (East Africa Time)",
      "updatedAt": "Tue Oct 01 2024 10:33:03 GMT+0300 (East Africa Time)",
      "defaultCalendar": true,
      "updatedBy": "66fba5a3d195e04a6f6137e3",
      "createdBy": "66fba5a3d195e04a6f6137e3",
      "timezone": "UTC",
      "baseDuration": null,
      "available": null
    },
    {
      "id": "66fba5d3d195e04a6f613818",
      "owner": {
        "id": "66fba5d0d195e04a6f61380f",
        "type": "profile"
      },
      "entityId": null,
      "entityType": null,
      "name": "user002last",
      "type": null,
      "color": "#51126B",
      "eventDuration": null,
      "schedule": null,
      "createdAt": "Tue Oct 01 2024 10:33:39 GMT+0300 (East Africa Time)",
      "updatedAt": "Tue Oct 01 2024 10:33:39 GMT+0300 (East Africa Time)",
      "defaultCalendar": true,
      "updatedBy": "66fba5d0d195e04a6f61380f",
      "createdBy": "66fba5d0d195e04a6f61380f",
      "timezone": "UTC",
      "baseDuration": null,
      "available": null
    },
    {
      "id": "66fba64ed195e04a6f61384c",
      "owner": {
        "id": "66fba64ad195e04a6f613846",
        "type": "organization"
      },
      "entityId": null,
      "entityType": null,
      "name": null,
      "type": null,
      "color": "#006451",
      "eventDuration": null,
      "schedule": null,
      "createdAt": "Tue Oct 01 2024 10:35:42 GMT+0300 (East Africa Time)",
      "updatedAt": "Tue Oct 01 2024 10:35:42 GMT+0300 (East Africa Time)",
      "defaultCalendar": false,
      "updatedBy": "66fba64ad195e04a6f613846",
      "createdBy": "66fba64ad195e04a6f613846",
      "timezone": "UTC",
      "baseDuration": null,
      "available": null
    }
  ],
  "cursor": {
    "next": "eyJpZCI6IjY2ZmJhNjRlZDE5NWUwNGE2ZjYxMzg0YyIsImRpcmVjdGlvbiI6ImFzYyJ9",
    "prev": null,
    "totalItems": 52
  }
}

Request

Query Params

name

string | null

optional

name

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 {16}]

required

string

required

name

string

required

Name of the calendar

color

string

required

Color of the calendar

eventDuration

number | null

optional

Default duration for events in the calendar

schedule

object | null

optional

Schedule settings of the calendar

createdAt

string

required

The date calendar created.

updatedAt

string

required

Last time calendar updated.

updatedBy

string

required

The user who updated the calendar.

defaultCalendar

boolean | null

optional

true if it is created through singup otherwise it is false.

entityId

string | null

optional

Used to identify the type of calendar and required only for course calendars and will be set to the course ID. For personal and other organization-created calendars, entityId is not needed.

entityType

string | null

optional

It specifies the type of calendar being created. It can be set to course, lecture, or category, depending on the nature of the calendar.

owner

object | null

optional

timezone

string | null

optional

time zone of your calendar like UTC, GMT ...

eventBaseDuration

number | null

optional

base duration of the events going to be created for this calendar.

isScheduleEnforced

boolean | null

optional

available

boolean

optional

if the calendar is available with given date

cursor

object

required

string | null

optional

string | null

optional

totalItems

integer | null

required

🟠403Forbidden

🟠401Unauthorized

Modified at 2025-03-31 10:27:07

Create a Calendar

List All Folder Calendars