GET api/2.0/calendar/subscriptions This function requires authentication

Description

Returns a list of all the subscriptions available to the current user.

Parameters

This method doesn't have any parameters.

Remark

Please note that the list of events in the response will be empty.

Example

GET api/2.0/calendar/subscriptions
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

Returns

List of subscriptions

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "isSubscribed": false,
      "group": "Personal Calendars",
      "isNew": true,
      "Permissions": {
        "Data": {
          "actions": [
            {
              "id": "read",
              "name": "Read only",
              "defaultAction": true,
              "defaultStyle": "read"
            }
          ],
          "items": [
            {
              "id": "2fdfe577-3c26-4736-9df9-b5a683bb8520",
              "name": "Everyone",
              "isGroup": true,
              "canEdit": true,
              "selectedAction": {
                "id": "read",
                "name": "Read only",
                "defaultAction": true,
                "defaultStyle": "read"
              }
            }
          ]
        }
      }
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <isSubscribed>False</isSubscribed>
    <group>Personal Calendars</group>
    <isNew>True</isNew>
    <Permissions>
      <Data>
        <actions>
          <id>read</id>
          <name>Read only</name>
          <defaultAction>True</defaultAction>
          <defaultStyle>read</defaultStyle>
        </actions>
        <items>
          <id>2fdfe577-3c26-4736-9df9-b5a683bb8520</id>
          <name>Everyone</name>
          <isGroup>True</isGroup>
          <canEdit>True</canEdit>
          <selectedAction>
            <id>read</id>
            <name>Read only</name>
            <defaultAction>True</defaultAction>
            <defaultStyle>read</defaultStyle>
          </selectedAction>
        </items>
      </Data>
    </Permissions>
  </response>
</result>