Get addressbooks¶

Fetch all addressbooks of authenticating MailUser

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

Response parameters¶

Parameter	Type	Description
addressbooks	list	List of all addressbooks
friendly_name	str	Name (identifier) of addressbook
status	str	Status
url	str	URL of CardDAV addressbook

Example request (Python)¶

import requests
import json
from pprint import pprint

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

Example response (JSON)¶

{'addressbooks': [{'friendly_name': 'default',
                   'status': 'generated',
                   'url': 'https://example.domain.tld/radicale/ab@vonmail.com/9c918738-2edf-44f3-aac5-7848bbf30a95/'},
                  {'friendly_name': 'Office',
                   'status': 'generated',
                   'url': 'https://example.domain.tld/radicale/ab@vonmail.com/be9ae280-45e8-4f81-acc3-c5a7ce1fb428/'}]}