Public API Reference (Beta)Contacts/ManagersSearch

Search contacts

Runs a full-text and filter-based search across contacts visible to the authenticated user. The request's `fields` list contains one entry per searchable field. Each field carries its own modifiers: - `required` — AND - `excluded` — NOT - optional exact-match, date and numeric ranges - nested OR-grouped sub-fields Pagination is controlled with `pageSize` and `startRecord`.

Authentication

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

Request

This endpoint expects an object.
fieldslist of objectsOptional

List of per-field criteria. An empty or omitted list returns all contacts visible to the authenticated user, subject to pagination.

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.

orderBystringOptional

Name of the field to sort by. Defaults to ‘score’ (relevance) when omitted.

orderDirstringOptional

Sort direction: ‘asc’ or ‘desc’.

locationstringOptional

Geo-spatial centre point for radius searches (postal code or city/state).

radiusintegerOptional

Geo-spatial search radius in miles, applied around ‘location’.

searchDeletedbooleanOptional

When true, include soft-deleted contacts in the results.

returnFieldslist of stringsOptional

Optional list of additional field names to populate on each hit, on top of the default set that is always returned. Field names must come from the catalog returned by GET /api/v1/contacts/search/fields and only entries flagged returnable=true in that catalog can be projected — fields with returnable=false are searchable but not stored, so listing them here has no effect on the response. The default set (always returned, regardless of this parameter) is: score, guid, client, client_contact_gk, first_name, last_name, environment, middle_name, nickname, username, title, email, work_email, department, email_allowed, city, state_name, state_abbr, country_code, country, address, address_2, postal_code. Use this parameter to pull in extra fields such as additional contact attributes or UDFs.

Response

Search results returned