search_relations
Search Yuki relations (customers/suppliers) by name, code, VAT number, or other fields. Get up to 100 contacts per page with IDs, codes, names, and contact details; omit searchValue to retrieve all contacts.
Instructions
Search for Yuki relations (customers/suppliers) by name, code, VAT number, or other fields. Returns up to 100 contacts per page with IDs, codes, names, and contact details. Omit searchValue (or pass an empty string) to retrieve all contacts.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| active | No | Filter by active status. Defaults to 'Active'. | Active |
| domainId | No | Domain ID (GUID). Defaults to YUKI_DOMAIN_ID env var. | |
| pageNumber | No | Page number for pagination (100 results per page). | |
| searchValue | No | The value to search for (e.g. company name, relation code). Omit or pass an empty string to retrieve all contacts (subject to Yuki API support). | |
| searchOption | No | Which field to search in. Defaults to 'All' (full-text search). | All |