Synology Contacts icon

Synology Contacts

Manage Synology Contacts (addressbooks, contacts, labels)

Actions18

Search Contacts

AI-generated

Summary

Search contacts in Synology Contacts by a keyword with pagination support.

Inputs

  • searchKeyword (required) — The keyword string to search contacts for.
  • limit — The maximum number of contacts to return (defaults to 50).
  • offset — The number of contacts to skip before starting to collect the result set (defaults to 0).

Output shape

a list of contact records matching the search keyword

The output supports pagination via the limit and offset inputs. The returned data includes contacts found using Synology Contacts APIs with keyword-based filtering.

Examples

Example 1: Search for contacts with 'John' in their details, limiting results to 20 and starting from the first result.

searchKeyword='John', limit=20, offset=0

Links

Discussion