GET/api/v1/calendars/{id}

Get calendar by ID

Retrieve a specific calendar by its ID

Authentication

Send your API key in the x-api-key header.

x-api-keybearer

Parameters

idrequired

path · string

Calendar ID

Responses

200Calendar retrieved successfully

PublicApiGetCalendarByIdResponseDto

statusCoderequired

number

countrequired

number

errorrequired

string

datarequired

PublicApiCalendarDto

Example response

json

{
  "statusCode": 200,
  "count": 0,
  "error": null,
  "data": {
    "id": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
    "name": "My Calendar",
    "description": "My personal calendar for work events",
    "hexColor": "#4285f4",
    "hexForegroundColor": "#ffffff",
    "isPrimary": false,
    "location": "New York, NY",
    "timezone": "America/New_York",
    "readOnly": false,
    "metadata": {
      "customField": "value"
    },
    "createdAt": "2024-07-15T09:00:00.000Z",
    "updatedAt": "2024-07-15T09:30:00.000Z"
  }
}

401Unauthorized - missing or invalid API key or Bearer token