Search contacts
yuki_search_contactsSearch the contacts (customers and suppliers) of a domain by name, city, postcode, tag, email, website, phone, code, Chamber of Commerce number, VAT number or bank account. Returns at most 100 contacts per page; ask for the next page_number until the reply is empty. Contact.SearchContacts.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| active | No | Active, inactive or both (default Both). | |
| offset | No | Skip this many contacts of the page (default 0). A long page is cut to fit the reply: use next_offset with the same page_number, then the next page_number. | |
| domain_id | No | Yuki domain id (from yuki_list_domains). Optional when the key has a single domain. | |
| sort_order | No | Sort order (default Name). | |
| page_number | No | Page number, starting at 1 (default 1). A page holds up to 100 contacts. | |
| search_value | No | Text to search for. Empty lists all contacts. | |
| search_option | No | Field to search in (default All). |