Search for a record. Please note, searches are limited to a maximum of 10,000 results.
Query parameters
limitintegerOptional
A limit on the number of objects to be returned with a range between 1 and 100. Defaults to 100.
offsetintegerOptional
Number of results to skip before returning response. Defaults to 0.
Request
This endpoint expects an object.
q
stringRequired
Query term. The syntax for the query parameter follows elasticsearch simple query string syntax. The includes the ability to use search operators and to perform nested queries. Must be url encoded.
fields
list of enumsOptional
Record or entity fields to search against.
filter
objectOptional
Filters to be applied to search query to limit the result-set.
facets
booleanOptional
Whether or not to return search facets in results giving counts by field. Defaults to false.
advanced
booleanOptional
Set to true to enable full elasticsearch query string syntax which allows for fielded search and more complex operators. Note that the syntax is more strict and can result in empty result-sets. Defaults to false.