Get Calendar Event Info

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

Use this endpoint to get information about a specific calendar event.

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
id
stringRequired

Enter the event ID.

Example6909b8ea4e7e8bcf6985b1a8
Responses
200

OK

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

Bad Request

Example 1
{
  "success": false,
  "error": "must have required property 'id' [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