fcrm search contacts
fcrm_search_contactsSearch FluentCRM contacts by name or email and return lightweight ID-keyed results for dropdowns and autocomplete; optionally load recent contacts when no search term is provided.
Instructions
Search contacts by name or email. Returns a lightweight object of contacts keyed by ID, suitable for dropdowns and autocomplete widgets. Optionally loads default contacts when no search term is provided.
Required capability: fcrm_read_contacts or fcrm_manage_contacts : which one applies depends on the action being performed.
Enforced by SubscriberPolicy::verifyRequest(), the policy default for this route group.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of results to return. | |
| offset | No | Rows to skip before the first result. Combine with `limit` to page through matches. | |
| search | No | Search term to match against contact name and email. | |
| values | No | Array of contact IDs to always include in results (useful for pre-selected values). | |
| account | No | Exact configured private account profile label; not a tenant or provider account ID. | |
| load_default | No | If truthy and no search term is provided, returns the most recent contacts. |