Get List of Calendar Events

Prev Next
Get
/api/v1/calendar-events.list

Use this endpoint to view the list of your calendar events for a specific date.

Header parameters
X-Auth-Token
stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
Query parameters
date
stringRequired

Enter the date for which you want to view the calendar events. Use the format YYYY-MM-DD.

Example2025-01-01
Responses
200

OK

Example 1
{
  "data": [
    {
      "_id": "690b02874e7e8bcf6985b27a",
      "uid": "C38WSSzrGd2NCjzqJ",
      "startTime": "2025-03-26T07:17:00Z",
      "endTime": "2025-03-26T07:18:00Z",
      "subject": "Subject8",
      "description": "Description8",
      "meetingUrl": null,
      "reminderMinutesBeforeStart": 10,
      "reminderTime": "2025-03-26T07:07:00Z",
      "notificationSent": false,
      "_updatedAt": "2025-11-05T07:53:43.420Z"
    }
  ],
  "success": true
}
Expand All
object
data
Array of object
object
success
boolean
400

Bad Request

Example 1
{
  "success": false,
  "error": "must have required property 'date' [invalid-params]",
  "errorType": "invalid-params"
}
object
success
boolean
error
string
errorType
string
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string