> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.brightmove.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.brightmove.com/_mcp/server.

# Universal search

POST https://app.brightmove.com/ATS/api/v1/universal/search
Content-Type: application/json

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.


Reference: https://docs.brightmove.com/public/universal-search/core/search

## Authentication

- `Authorization` header (bearer token, required) — BrightMove OAuth2 client_credentials - use the client_id/client_secret from User > API Keys (or an admin-managed client).

## Request

### Body (application/json)

This endpoint expects an UniversalSearchRequest.

- `query` (string, required) — 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.
- `pageSize` (integer, optional) — Number of results to return per page. Defaults to 25 if omitted. Capped at 100 by the server.
- `startRecord` (integer, optional) — Zero-based offset of the first record to return. Use multiples of 'pageSize' to page through results.
- `assumeWildcard` (boolean, optional) — 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.
- `entityTypes` (enum, optional) — 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.
  - Allowed values: `APPLICANT`, `CONTACT`, `OFFICE`, `CLIENT`, `REQUIREMENT`

## Response

### 200

Search results returned

## Examples

**Request**

```json
{
  "query": "smith"
}
```

**Response**

```json
{}
```

**SDK Code**

```python
import requests

url = "https://app.brightmove.com/ATS/api/v1/universal/search"

payload = { "query": "smith" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://app.brightmove.com/ATS/api/v1/universal/search';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"query":"smith"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.brightmove.com/ATS/api/v1/universal/search"

	payload := strings.NewReader("{\n  \"query\": \"smith\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://app.brightmove.com/ATS/api/v1/universal/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"query\": \"smith\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://app.brightmove.com/ATS/api/v1/universal/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"smith\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://app.brightmove.com/ATS/api/v1/universal/search', [
  'body' => '{
  "query": "smith"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://app.brightmove.com/ATS/api/v1/universal/search");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"query\": \"smith\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["query": "smith"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://app.brightmove.com/ATS/api/v1/universal/search")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```