Expand description
JSON REST API types for contacts and address books.
The shape is structured-only: server owns vCard generation and field extraction; clients never see raw vCard text. Custom vCard properties sent by external CardDAV clients are preserved in the stored blob but invisible to JSON responses.
Structs§
- Address
Book Create - Address
Book Output - Address
Book Patch - Contact
Input - Body for
POST /api/address-books/{abId}/contacts(create) andPUT /api/address-books/{abId}/contacts/{uid}(replace). - Contact
List Item - Summary row for list endpoints (omits emails[]/phones[] detail to keep list responses small).
- Contact
Name - vCard N (structured name) property.
- Contact
Output - Full contact response including server-side metadata and optional live profile overlay.
- Contact
Patch - Body for
PATCH /api/address-books/{abId}/contacts/{uid}. Each field usesPatch<T>so clients can distinguish “leave alone” from “clear”. - Import
Contacts Error - Import
Contacts Query - Import
Contacts Result - List
Contacts Query - Profile
Overlay - Live profile data returned alongside a contact that has
profileIdTagset. Fetched per-request from the tenant’sprofilestable; never written into storage. - Typed
Value - A value with TYPE and PREF parameters — covers EMAIL, TEL, URL, etc.
Enums§
- Import
Conflict Mode - How to handle a vCard whose UID matches an existing contact in the address book.