Skip to main content
POST
/
projects
/
{projectIdOrName}
/
integrations
/
{integrationId}
Search records
curl --request POST \
  --url https://search.withampersand.com/v1/projects/{projectIdOrName}/integrations/{integrationId} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "objectName": "contact",
  "fieldFilters": [
    {
      "fieldName": "email",
      "operator": "eq",
      "value": "example@example.com"
    }
  ]
}
'
{
  "result": [
    {
      "fields": {},
      "mappedFields": {},
      "raw": {}
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.withampersand.com/llms.txt

Use this file to discover all available pages before exploring further.

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

​
objectName
string
required

The name of the object to search.

Example:

"contact"

​
fieldFilters
FieldFilter · object[]
required

The field filters to apply to the search.

Example:
[
  {
    "fieldName": "email",
    "operator": "eq",
    "value": "example@example.com"
  }
]

Response

The search results

​
result
Search Result Entry · object[]