Zum Inhalt springen

Kontakte-API

Alle Endpunkte erfordern Authentifizierung. Basispfad: /api/v1/address-books.

MethodePfadBeschreibung
GET/v1/address-booksAdressbücher auflisten
POST/v1/address-booksEin Adressbuch erstellen (name; 409 falls bereits vorhanden)
PUT/v1/address-books/{addressBookId}Die Farbe eines Adressbuchs aktualisieren
DELETE/v1/address-books/{addressBookId}Ein Adressbuch löschen
MethodePfadBeschreibung
GET/v1/address-books/contactsAlle Kontakte auflisten
POST/v1/address-books/contacts/photosKontaktfoto-URLs im Bulk abrufen (max. 10)
POST/v1/address-books/{addressBookId}/contactsEinen Kontakt erstellen
PUT/v1/address-books/{addressBookId}/contacts/{contactUri}Einen Kontakt aktualisieren
DELETE/v1/address-books/{addressBookId}/contacts/{contactUri}Einen Kontakt löschen
POST/v1/address-books/{addressBookId}/contacts/{contactUri}/photoEin Kontaktfoto hochladen (multipart)
DELETE/v1/address-books/{addressBookId}/contacts/{contactUri}/photoEin Kontaktfoto entfernen

Beim Erstellen eines Kontakts werden akzeptiert: vollständige Namensbestandteile (Präfix, Vorname, zweiter Vorname, Nachname, Suffix), mehrere emails[] und phones[] mit Typ (privat/geschäftlich/mobil/sonstiges), groups[], organization, title, note, eine vollständige Adresse und ein optionales photo (base64).

MethodePfadBeschreibung
POST/v1/address-books/importEinen externen CardDAV-Import starten (url, username, secret)
POST/v1/address-books/import/selectZu importierende Adressbücher auswählen
GET/v1/address-books/import/stateFortschritt des Imports