Search records

Search records in a SaaS instance.

POST /projects/{projectIdOrName}/integrations/{integrationId}

Search records

cURL

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": "[e-mail]"
    }
  ]
}
'

import requests

url = "https://search.withampersand.com/v1/projects/{projectIdOrName}/integrations/{integrationId}"

payload = {
    "objectName": "contact",
    "fieldFilters": [
        {
            "fieldName": "email",
            "operator": "eq",
            "value": "[e-mail]"
        }
    ]
}
headers = {
    "X-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    objectName: 'contact',
    fieldFilters: [{fieldName: 'email', operator: 'eq', value: '[e-mail]'}]
  })
};

fetch('https://search.withampersand.com/v1/projects/{projectIdOrName}/integrations/{integrationId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://search.withampersand.com/v1/projects/{projectIdOrName}/integrations/{integrationId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'objectName' => 'contact',
    'fieldFilters' => [
        [
                'fieldName' => 'email',
                'operator' => 'eq',
                'value' => '[e-mail]'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://search.withampersand.com/v1/projects/{projectIdOrName}/integrations/{integrationId}"

	payload := strings.NewReader("{\n  \"objectName\": \"contact\",\n  \"fieldFilters\": [\n    {\n      \"fieldName\": \"email\",\n      \"operator\": \"eq\",\n      \"value\": \"[e-mail]\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Api-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://search.withampersand.com/v1/projects/{projectIdOrName}/integrations/{integrationId}")
  .header("X-Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"objectName\": \"contact\",\n  \"fieldFilters\": [\n    {\n      \"fieldName\": \"email\",\n      \"operator\": \"eq\",\n      \"value\": \"[e-mail]\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://search.withampersand.com/v1/projects/{projectIdOrName}/integrations/{integrationId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"objectName\": \"contact\",\n  \"fieldFilters\": [\n    {\n      \"fieldName\": \"email\",\n      \"operator\": \"eq\",\n      \"value\": \"[e-mail]\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

200

{
  "result": [
    {
      "fields": {},
      "mappedFields": {},
      "raw": {}
    }
  ]
}

{
  "type": "urn:problem-type:exampleOrganization:exampleProblem",
  "href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types",
  "title": "Description of the type of problem that occurred",
  "status": 400,
  "detail": "Description of specific occurrence of the problem",
  "instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000"
}

{
  "type": "urn:problem-type:exampleOrganization:exampleProblem",
  "href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types",
  "title": "Description of the type of problem that occurred",
  "status": 400,
  "detail": "Description of specific occurrence of the problem",
  "instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000"
}

{
  "type": "urn:problem-type:exampleOrganization:exampleProblem",
  "href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types",
  "title": "Description of the type of problem that occurred",
  "status": 400,
  "detail": "Description of specific occurrence of the problem",
  "instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000"
}

Authorizations

APIKeyHeaderBearer

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.

Show child attributes

Example:

[
  {
    "fieldName": "email",
    "operator": "eq",
    "value": "[e-mail]"
  }
]

Response

200

application/json

The search results

result · Search Result Entry · object[]

Show child attributes