Skip to main content
The Simple Search API allows you to search across all text fields in all entities.

​
Endpoint

GET http://domain.com/api/rest/latest/search
The API only supports GET requests.

​
Query parameters

​
search
string
required
The search string.
​
offset
integer
The integer offset for paginating results.
​
max_results
integer
The maximum number of records to return in the response.

​
Example request

GET http://domain.com/api/rest/latest/search?max_results=100&offset=0&search=search_string

​
Response format

The response contains the following fields:
​
records_count
integer
The total number of results, without applying offset and max_results limits.
​
count
integer
The count of records returned in the current request.
​
data
array
An array of matching records.

Build docs developers (and LLMs) love

Get started for freeTalk to us