FluentCRM Developers

Appearance

View as Markdown

GET Search Contacts​

GET
/subscribers/search-contacts

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

Enforced by SubscriberPolicy::verifyRequest(), the policy default for this route group.

Authorizations​

ApplicationPasswords

WordPress Application Passwords — use Basic auth with your WordPress username and an application password in the format: username:application_password

Type
API Key (header: Authorization)

Parameters​

Query Parameters

search

Search term to match against contact name and email.

Type
string
limit

Maximum number of results to return.

Type
integer
Default
20
load_default

If truthy and no search term is provided, returns the most recent contacts.

Type
string
Valid values
"true""false""1""0""yes"
values[]

Array of contact IDs to always include in results (useful for pre-selected values).

Type
array
offset

Rows to skip before the first result. Combine with limit to page through matches.

Type
integer
Default
0

Responses​

Object of contacts keyed by contact ID.

application/json
JSON
{
"contacts": {
"additionalProperties": {
"first_name": "string",
"last_name": "string",
"full_name": "string",
"email": "string",
"id": "string"
}
}
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI