Get shares

Fetch calendars shared by you (authenticating MailUser) and with you (from other MailUsers)

  • HTTP Method: GET
  • URL: https://example.domain.tld/api/v1/calendars/share/
  • Require authentication: Yes
  • Permission level required: MailUser

Response parameters

Parameter Type Description
shared_by_me list List of all calendars shared by you (authenticating MailUser)
friendly_name str Name (identifier) of calendar
recipients list List of recipient addresses
status str Status
url str URL of CalDAV calendar
shared_with_me list List of all calendars shared with you (from other MailUsers)
from str MailUser who shared the calendar with you

Example request (Python)

import requests
import json
from pprint import pprint

url = "https://example.domain.tld/api/v1/calendars/share/"
r = requests.get(url, auth=("","long-auth_token-here"))

Example response (JSON)

{'shared_by_me': [{'friendly_name': 'default',
                   'recipients': ['', ''],
                   'status': 'applied',
                   'url': 'https://example.domain.tld/radicale/'}],
 'shared_with_me': [{'friendly_name': 'Project NMS',
                     'from': '',
                     'status': 'applied',
                     'url': 'https://example.domain.tld/radicale/'}]}