Get Started
Portal api methods
Help

GET api/2.0/calendar/calendars/{startDate}/{endDate} This function requires authentication

Description

Returns the list of calendars and subscriptions with the events for the current user for the selected period

Parameters
Name Description Type Example
startDate
sent in url
Period start date Date and Time Roundtrip format: 2008-04-10T06-30-00.000Z
endDate
sent in url
Period end date Date and Time Roundtrip format: 2008-04-10T06-30-00.000Z
Example
GET api/2.0/calendar/calendars/2008-04-10T06-30-00.000Z/2008-04-10T06-30-00.000Z
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

List of calendars and subscriptions with events

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "canEditTimeZone": false,
      "timeZone": {
        "offset": 0,
        "id": "UTC",
        "name": "UTC"
      },
      "defaultAlert": {
        "type": -1
      },
      "events": [
        {
          "owner": {
            "objectId": "2fdfe577-3c26-4736-9df9-b5a683bb8520",
            "name": "Valery Zykov"
          },
          "permissions": {
            "users": [
              {
                "objectId": "2fdfe577-3c26-4736-9df9-b5a683bb8520",
                "name": "Valery Zykov"
              }
            ]
          },
          "isEditable": false,
          "сanUnsubscribe": true,
          "isShared": true,
          "alert": {
            "type": -1
          },
          "repeatRule": "",
          "start": "2019-12-16T06:37:51.4930126Z",
          "end": "2019-12-16T06:37:51.5085785Z",
          "allDay": false,
          "description": "Event Description",
          "title": "Event Name",
          "objectId": "1",
          "sourceId": "calendarID",
          "status": 0
        }
      ],
      "owner": {
        "objectId": "2fdfe577-3c26-4736-9df9-b5a683bb8520",
        "name": "Valery Zykov"
      },
      "objectId": "1",
      "title": "Calendar Name",
      "description": "Calendar Description",
      "backgroundColor": "#000000",
      "textColor": "#ffffff",
      "isEditable": true,
      "permissions": {
        "data": {
          "actions": [
            {
              "id": "read",
              "name": "Read only",
              "defaultAction": true
            }
          ],
          "items": [
            {
              "selectedAction": {
                "id": "read",
                "name": "Read only",
                "defaultAction": true
              },
              "canEdit": true,
              "isGroup": true,
              "name": "Everyone",
              "id": "2fdfe577-3c26-4736-9df9-b5a683bb8520"
            }
          ]
        }
      },
      "isShared": true,
      "canAlertModify": true,
      "isHidden": false,
      "isiCalStream": false,
      "isSubscription": false
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <canEditTimeZone>false</canEditTimeZone>
    <timeZone>
      <offset>0</offset>
      <id>UTC</id>
      <name>UTC</name>
    </timeZone>
    <defaultAlert>
      <type>-1</type>
    </defaultAlert>
    <events>
      <owner>
        <objectId>2fdfe577-3c26-4736-9df9-b5a683bb8520</objectId>
        <name>Valery Zykov</name>
      </owner>
      <permissions>
        <users>
          <objectId>2fdfe577-3c26-4736-9df9-b5a683bb8520</objectId>
          <name>Valery Zykov</name>
        </users>
      </permissions>
      <isEditable>false</isEditable>
      <сanUnsubscribe>true</сanUnsubscribe>
      <isShared>true</isShared>
      <alert>
        <type>-1</type>
      </alert>
      <repeatRule></repeatRule>
      <start>2019-12-16T06:37:51.4930126Z</start>
      <end>2019-12-16T06:37:51.5085785Z</end>
      <allDay>false</allDay>
      <description>Event Description</description>
      <title>Event Name</title>
      <objectId>1</objectId>
      <sourceId>calendarID</sourceId>
      <status>0</status>
    </events>
    <owner>
      <objectId>2fdfe577-3c26-4736-9df9-b5a683bb8520</objectId>
      <name>Valery Zykov</name>
    </owner>
    <objectId>1</objectId>
    <title>Calendar Name</title>
    <description>Calendar Description</description>
    <backgroundColor>#000000</backgroundColor>
    <textColor>#ffffff</textColor>
    <isEditable>true</isEditable>
    <permissions>
      <data>
        <actions>
          <id>read</id>
          <name>Read only</name>
          <defaultAction>true</defaultAction>
        </actions>
        <items>
          <selectedAction>
            <id>read</id>
            <name>Read only</name>
            <defaultAction>true</defaultAction>
          </selectedAction>
          <canEdit>true</canEdit>
          <isGroup>true</isGroup>
          <name>Everyone</name>
          <id>2fdfe577-3c26-4736-9df9-b5a683bb8520</id>
        </items>
      </data>
    </permissions>
    <isShared>true</isShared>
    <canAlertModify>true</canAlertModify>
    <isHidden>false</isHidden>
    <isiCalStream>false</isiCalStream>
    <isSubscription>false</isSubscription>
  </response>
</result>