Get shares¶

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

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

Response parameters¶

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

Example request (Python)¶

import requests
import json
from pprint import pprint

url = "https://example.domain.tld/api/v1/contacts/share/"
r = requests.get(url, auth=("ab@vonmail.com","long-auth_token-here"))
try:
    pprint(r.json())
except:
    print(r.text)

Example response (JSON)¶

{'shared_by_me': [{'friendly_name': 'default',
                   'recipients': ['u1@vonmail.com', 'u2@vonmail.com'],
                   'status': 'applied',
                   'url': 'https://example.domain.tld/radicale/ab@vonmail.com/67763625-112a-405a-a169-598fe63e11af/'}],
 'shared_with_me': [{'friendly_name': 'Project NMS',
                     'from': 'u1@vonmail.com',
                     'status': 'applied',
                     'url': 'https://example.domain.tld/radicale/ab@vonmail.com/1fdf302f-62b2-46d0-9f0e-8fbf898bc826/'}]}