Scheduled Maintenance External Calendar

List Scheduled Maintenance External Calendar

Endpoint to list all Scheduled Maintenance External Calendar items

post/scheduled-maintenance-external-calendar/get-list

Request

Request body

limitnumber

Maximum number of items to return. Defaults to 10.

skipnumber

Number of items to skip for pagination. Defaults to 0.

Example request

{
  "query": {
    "createdAt": {
      "_type": "GreaterThan",
      "value": "2026-01-01T00:00:00.000Z"
    },
    "name": {
      "_type": "Search",
      "value": "example"
    }
  },
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "name": true,
    "calendarHost": true,
    "lastReadError": true
  },
  "sort": {
    "createdAt": "DESC"
  }
}

Response

Successful response

countnumber

Example response

{
  "data": [
    {
      "_id": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "updatedAt": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "deletedAt": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "version": 42,
      "projectId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Public holidays",
      "calendarHost": "calendar.google.com",
      "color": {
        "_type": "Color",
        "value": "#ff0000"
      },
      "isEnabled": true,
      "refreshIntervalInMinutes": 42,
      "lastReadAt": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "lastReadAttemptAt": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "lastReadError": "NotFound",
      "lastReadHttpStatus": 42,
      "eventCount": 42,
      "hasMoreEvents": true,
      "nextReadAt": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "createdByUserId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.