# Search API



<EndpointIndex
  names={[
  	'fetchSearchResults',
  	'fetchAdditionalSearchResultsByToken',
  	'fetchSearchStats',
  	'fetchIndexedFields',
  	'fetchIgnoredFields',
  ]}
/>

Data Search [#data-search]

<Callout type="warn">
  To execute a search, you need the `search.read` permission, along with the `read` permission for each entity type you want to search (e.g. `policies.read` to search policies). See the [permissions listing](/features/security/permissions-listing) for the permissions available for each entity.
</Callout>

Fetch Search Results [#fetch-search-results]

<ApiEndpoint name="fetchSearchResults" />

<ApiSchema name="SearchRequest" />

<ApiSchema name="SearchTermRequest" />

<ApiSchema name="SearchServiceResponse" />

<ApiSchema name="SearchResultResponse" />

Fetch Additional Search Results By Token [#fetch-additional-search-results-by-token]

<ApiEndpoint name="fetchAdditionalSearchResultsByToken" />

Fetch Search Stats [#fetch-search-stats]

<ApiEndpoint name="fetchSearchStats" />

<ApiSchema name="SearchStatsResponse" />

<ApiSchema name="SearchStatsResult" />

Fetch Indexed Fields [#fetch-indexed-fields]

<ApiEndpoint name="fetchIndexedFields" />

<ApiEndpoint name="fetchIgnoredFields" />

<ApiSchema name="FieldsRequest" />

<ApiSchema name="FieldsMappingResponse" />

<ApiSchema name="Field" />

See Also [#see-also]

* [Search Feature Guide](/features/search)


## API Reference

POST /search/{tenantLocator}/search — fetchSearchResults
Permissions: read
Parameters:
  tenantLocator (uuid, path, required)
  offset (integer, query)
  count (integer, query)
Request body (SearchRequest):
Responses:
  200 SearchServiceResponse — OK

GET /search/{tenantLocator}/search — fetchAdditionalSearchResultsByToken
Permissions: read
Parameters:
  tenantLocator (uuid, path, required)
  offset (integer, query)
  count (integer, query)
  searchToken (string, query, required) — The token returned from the initial search
Responses:
  200 SearchServiceResponse — OK

POST /search/{tenantLocator}/search/searchStats — fetchSearchStats
Permissions: read
Parameters:
  tenantLocator (uuid, path, required)
Request body (SearchRequest):
Responses:
  200 SearchStatsResponse — OK

GET /search/{tenantLocator}/search/fieldsMapping — fetchIndexedFields
Permissions: read
Parameters:
  tenantLocator (uuid, path, required)
  request (FieldsRequest, query, required)
Responses:
  200 FieldsMappingResponse[] — OK

GET /search/{tenantLocator}/search/ignoredFields — fetchIgnoredFields
Permissions: read
Parameters:
  tenantLocator (uuid, path, required)
  request (FieldsRequest, query, required)
Responses:
  200 FieldsMappingResponse[] — OK

SearchRequest
Properties:
  searchString (string, required)
  searchEntityType (Enum unspecified | account | quote | policy | fnol | contact | diary | payment | task | userAssociation)
  searchTerms (SearchTermRequest[], required)
  startCreationTime (datetime)
  endCreationTime (datetime)
  sortField (string)
  sortOrder (Enum Asc | Desc)
  fields (string[])

SearchTermRequest
Properties:
  searchTerm (string, required)
  fieldName (string, required)
  match (Enum fuzzy | exact | startsWith | lessThan | greaterThan, required)
  absolute (Enum none | required | excluded, required)

SearchServiceResponse
Properties:
  searchToken (string, required)
  offset (integer, required)
  count (integer, required)
  results (SearchResultResponse[], required)

SearchResultResponse
Properties:
  score (number, required)
  searchEntityType (Enum unspecified | account | quote | policy | fnol | contact | diary | payment | task | userAssociation, required)
  searchEntityLocator (ulid, required)
  productName (string, required)
  accountLocator (string, required)
  configVersionLocator (string, required)
  searchSummary (map<string, object>, required)
  highlights (string[], required)

SearchStatsResponse
Properties:
  searchToken (string, required)
  results (SearchStatsResult[], required)

SearchStatsResult
Properties:
  searchEntityType (Enum unspecified | account | quote | policy | fnol | contact | diary | payment | task | userAssociation, required)
  recordCount (integer, required)

FieldsRequest
Properties:
  searchEntityType (Enum unspecified | account | quote | policy | fnol | contact | diary | payment | task | userAssociation, required)

FieldsMappingResponse
Properties:
  index (string, required)
  fields (Field[], required)

Field
Properties:
  name (string, required)
  type (Enum TEXT | DATE | OTHER, required)