Search companies
sellsy_search_companiesSearch companies by name, email, type (prospect/client/supplier), reference, VAT, SIRET, country, postal code, creation or update date. Needs companies.read.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| embed | No | Related objects to include (each may need an extra scope and is null without it), e.g. ["invoicing_address","main_contact","cf.1542"]. | |
| field | No | Only return these fields, e.g. ["id","name"] or ["address.id"], to keep replies small. | |
| limit | No | Records per page, 1-100 (default 25). | |
| order | No | Sort field: name, id, created_at, updated_at. | |
| offset | No | Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit. | |
| filters | No | Search filters as an object. Unknown keys are refused by Sellsy. Keys: name (exact), email (exact), type ("prospect"|"client"|"supplier" or an array), is_archived (bool), siret, vat, reference [..], id [ids], contacts [contact ids], country_code, postal_code [..], created {start,end} ISO date-times, updated_at {start,end} ISO date-times, number_of_employees {min,max}. | |
| direction | No | Sort direction (default asc). |