Get Started
Portal api methods
Help

GET api/2.0/calendar/{calendarId}/sharing This function requires authentication

Description

Returns the sharing access parameters to the calendar with the ID specified in the request

Parameters
Name Description Type Example
calendarId
sent in url
Calendar ID number 1234
Example
GET api/2.0/calendar/1234/sharing
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

Sharing access parameters

Example Response

application/json

{
  "status": 0,
  "response": {
    "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"
      }
    ]
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <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>
  </response>
</result>