Public API Reference (Beta)Universal SearchCore

Universal search

Runs a single free-text query against the aggregated cross-entity index. The query is matched against the principal text-typed fields of every entity (names, addresses, emails, etc.) that were combined into a single aggregated text index at index time. Per-field criteria are **not** supported — the only inputs are `query`, `entityTypes` (filter), pagination, and `assumeWildcard`. Results are filtered to entity types the user has the corresponding `SEARCH_*` permission for; the optional `entityTypes` parameter further narrows the search.

Authentication

X-Brightmove-Company-ApiKeystring
BrightMove Company Api Key
X-Brightmove-User-ApiKeystring
BrightMove User Api Key

Request

This endpoint expects an object.
querystringRequired

Free-text search term. Matched against the aggregated ‘text’ index that combines the principal text-typed fields of every entity (name, address, email, phone, etc.). Wildcards are supported when ‘assumeWildcard’ is true.

pageSizeintegerOptional
Number of results to return per page. Defaults to 25 if omitted. Capped at 100 by the server.
startRecordintegerOptional

Zero-based offset of the first record to return. Use multiples of ‘pageSize’ to page through results.

assumeWildcardbooleanOptional

When true, each whitespace-separated token in ‘query’ is wildcard-expanded (suffix ’*’) if it doesn’t already end in one. Mirrors the legacy ‘assume_wildcard_allsite’ company preference. Defaults to true if omitted.

entityTypesenumOptional

Optional filter on the entity types to include in the results. When omitted, all entity types the authenticated user has the corresponding SEARCH_* permission for are searched.

Response

Search results returned