Search

In addition to structured query filters, search endpoints accept an optional search string for keyword-style lookup.

`search` vs `query`

Field	Purpose
`query`	Structured filter expressions (`equals`, `contains`, `and`, `or`, …)
`search`	Free-text search across the resource’s searchable fields

You can use them together:

{
  "search": "john acme",
  "query": "equals(status, 'open')",
  "sortBy": "desc(updatedAt)",
  "pagination": { "page": 0, "limit": 25 }
}

Request shape

{
  "search": "your keywords here"
}

search is a plain string. Matching behavior (which columns are searched and how terms are tokenized) depends on the resource. Each search endpoint documents the search property in the API reference.

GETTING STARTED

HEYY API

`search` vs `query`

Request shape

​search vs query

​Request shape

`search` vs `query`

Request shape