Skip to main content
POST
Search records

Authorizations

X-Api-Key
string
header
required

Path Parameters

projectIdOrName
string
required
integrationId
string
required

Query Parameters

groupRef
string
required

The group reference for the search request.

Body

application/json

Search request

Exactly one of fieldFilters or rawFilter must be given.

objectName
string
required

The name of the object to search.

Example:

"contact"

fieldFilters
FieldFilter · object[]

The field filters to apply to the search.

Example:
rawFilter
Raw Filter · object

A filter in the provider's native query syntax. It cannot be combined with fieldFilters. It can apply to incremental reads, backfills or a search API call.

Response

The search results

result
Search Result Entry · object[]