Find unique record

cURL

curl --request POST \
  --url https://api.unifygtm.com/data/v1/objects/{object_name}/records/find-unique \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "match": {}
}'

import requests

url = "https://api.unifygtm.com/data/v1/objects/{object_name}/records/find-unique"

payload = { "match": {} }
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({match: {}})
};

fetch('https://api.unifygtm.com/data/v1/objects/{object_name}/records/find-unique', 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://api.unifygtm.com/data/v1/objects/{object_name}/records/find-unique",
  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([
    'match' => [
        
    ]
  ]),
  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://api.unifygtm.com/data/v1/objects/{object_name}/records/find-unique"

	payload := strings.NewReader("{\n  \"match\": {}\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://api.unifygtm.com/data/v1/objects/{object_name}/records/find-unique")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"match\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.unifygtm.com/data/v1/objects/{object_name}/records/find-unique")

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  \"match\": {}\n}"

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

{
  "status": "success",
  "data": {
    "object": "<string>",
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "attributes": {}
  }
}

{
  "status": "bad_request",
  "errors": [
    {
      "code": "<string>",
      "path": [
        "<string>"
      ],
      "object_api_name": "<string>",
      "attribute_api_name": "<string>"
    }
  ],
  "message": "<string>"
}

{
  "status": "unauthorized",
  "message": "<string>"
}

{
  "status": "object_not_found",
  "message": "<string>"
}

{
  "status": "error",
  "message": "<string>"
}

POST

data

objects

{object_name}

records

find-unique

cURL

curl --request POST \
  --url https://api.unifygtm.com/data/v1/objects/{object_name}/records/find-unique \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "match": {}
}'

import requests

url = "https://api.unifygtm.com/data/v1/objects/{object_name}/records/find-unique"

payload = { "match": {} }
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({match: {}})
};

fetch('https://api.unifygtm.com/data/v1/objects/{object_name}/records/find-unique', 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://api.unifygtm.com/data/v1/objects/{object_name}/records/find-unique",
  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([
    'match' => [
        
    ]
  ]),
  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://api.unifygtm.com/data/v1/objects/{object_name}/records/find-unique"

	payload := strings.NewReader("{\n  \"match\": {}\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://api.unifygtm.com/data/v1/objects/{object_name}/records/find-unique")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"match\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.unifygtm.com/data/v1/objects/{object_name}/records/find-unique")

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  \"match\": {}\n}"

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

{
  "status": "success",
  "data": {
    "object": "<string>",
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "attributes": {}
  }
}

{
  "status": "bad_request",
  "errors": [
    {
      "code": "<string>",
      "path": [
        "<string>"
      ],
      "object_api_name": "<string>",
      "attribute_api_name": "<string>"
    }
  ],
  "message": "<string>"
}

{
  "status": "unauthorized",
  "message": "<string>"
}

{
  "status": "object_not_found",
  "message": "<string>"
}

{
  "status": "error",
  "message": "<string>"
}

Overview

Find a record using a unique attribute, such as a company’s domain or a person’s email address. Put the attribute values inside match. Additional attributes narrow the match, and at least one must be unique on the object.

Examples

Set UNIFY_API_KEY to your API key.

Find a company by domain

Replace the example domain with the company to find:

curl --request POST \
  --url "https://api.unifygtm.com/data/v1/objects/company/records/find-unique" \
  --header "X-Api-Key: $UNIFY_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "match": {
    "domain": "northstar.example"
  }
}'

The response’s data contains the matching record, or null when no record matches. Use the returned ID to update the record or add it to a list.

Find a person by email

curl --request POST \
  --url "https://api.unifygtm.com/data/v1/objects/person/records/find-unique" \
  --header "X-Api-Key: $UNIFY_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "match": {
    "email": "alex@northstar.example"
  }
}'

Find a custom record

If user_id is a unique attribute on your product_user object, find a record by that ID. Including plan additionally requires the record to have that value:

curl --request POST \
  --url "https://api.unifygtm.com/data/v1/objects/product_user/records/find-unique" \
  --header "X-Api-Key: $UNIFY_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "match": {
    "user_id": "trial-user-1042",
    "plan": "enterprise"
  }
}'

All supplied criteria must match. The custom object and these attributes must exist before you query them.

Authorizations

x-api-key

string

header

required

Path Parameters

object_name

string

required

The API name of an object, e.g. company, person, opportunity, or a custom object's API name.

Body

application/json

Request body for finding a unique record by attribute values.

match

object

required

Attribute values used to find an existing record. Include at least one unique attribute. Additional attributes narrow the match.

Response

Response for a successful get operation.

status

enum<string>

required

Available options:

success

data

object | null

required

Show child attributes

⌘I

Unify platform

MCP

Developer guides

API reference

SDKs

Find unique record

Overview

Examples

Authorizations

Path Parameters

Body

Response

​Overview

​Examples

Authorizations

Path Parameters

Body

Response

Overview

Examples