Contacts
This API is partially documented or under construction.
Overview​
Synology Contacts API implementation.
Provides read-only access to address books, contacts, labels, external sources, and organizational units.
Methods​
get_addressbook_list​
Get the list of address books.
Internal API​
SYNO.Contacts.Addressbook
Returns​
dict[str, object] or str
Address book list or error message.
get_contact_list​
Get the list of contacts.
Internal API​
SYNO.Contacts.Contact
Parameters​
limit int
Maximum number of contacts to return.
offset int
Starting index for pagination.
Returns​
dict[str, object] or str
Contact list or error message.
get_contact​
Get a single contact by ID.
Internal API​
SYNO.Contacts.Contact
Parameters​
contact_id str
Contact ID.
Returns​
dict[str, object] or str
Contact details or error message.
get_label_list​
Get the list of labels.
Internal API​
SYNO.Contacts.Label
Returns​
dict[str, object] or str
Label list or error message.
get_info​
Get the current user information.
Internal API​
SYNO.Contacts.Info
Returns​
dict[str, object] or str
User info or error message.
get_ou_list​
Get the list of organizational units.
Internal API​
SYNO.Contacts.OU
Returns​
dict[str, object] or str
Organizational unit list or error message.
get_external_source_list​
Get the list of external contact sources.
Internal API​
SYNO.Contacts.ExternalSource
Returns​
dict[str, object] or str
External source list or error message.
create_contact​
Create a new contact.
Internal API​
SYNO.Contacts.Contact
Parameters​
full_name str
Contact full name.
addressbook_id int
Target address book ID.
_kwargs_** dict[str, object]
Additional contact fields (email, phone, company, etc.).
Returns​
dict[str, object] or str
Created contact or error message.
delete_contact​
Delete a contact by ID.
Internal API​
SYNO.Contacts.Contact
Parameters​
contact_id int
Contact ID.
Returns​
dict[str, object] or str
Result or error message.
set_contact​
Update an existing contact.
Internal API​
SYNO.Contacts.Contact
Parameters​
contact_id int
Contact ID.
_kwargs_** dict[str, object]
Contact fields to update.
Returns​
dict[str, object] or str
Updated contact or error message.