Look up a person by email address, LinkedIn URL, email domain, or name.
curl --request GET \
--url https://production-api.joinrings.com/v1/persons/lookup \
--header 'x-api-key: <api-key>'import requests
url = "https://production-api.joinrings.com/v1/persons/lookup"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://production-api.joinrings.com/v1/persons/lookup', 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://production-api.joinrings.com/v1/persons/lookup",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://production-api.joinrings.com/v1/persons/lookup"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://production-api.joinrings.com/v1/persons/lookup")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.joinrings.com/v1/persons/lookup")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"count": 123,
"matches": [
{
"email": "<string>",
"last_activity_date": "<string>",
"linkedin_url": "<string>",
"name": "<string>",
"uuid": "<string>",
"city": "<string>",
"company_name": "<string>",
"country": "<string>",
"current_company": {
"company_name": "<string>",
"logo_url": "<string>",
"uuid": "<string>",
"job_type": "<string>",
"source": "<string>"
},
"current_company_domain": "<string>",
"current_company_name": "<string>",
"current_job_title": "<string>",
"description": "<string>",
"email_last_seen": "<string>",
"entity_lists": [
{
"name": "<string>",
"uuid": "<string>"
}
],
"is_primary_company_recommended": true,
"job_changed_at": "<string>",
"job_title": "<string>",
"last_contact_at": "<string>",
"logo_url": "<string>",
"my_next_meeting_at": "<string>",
"my_next_meeting_title": "<string>",
"next_meeting_at": "<string>",
"next_meeting_title": "<string>",
"next_meeting_with_user_uuid": "<string>",
"pathpower": {
"meta": {},
"score": 123,
"strength_label": "<string>"
},
"previous_job_ended_at": "<string>",
"secondary_email": "<string>",
"secondary_email_last_seen": "<string>",
"similarity_score": 123,
"state": "<string>",
"strongest_relationships": [
{
"internal_user_person_uuid": "<string>",
"internal_user_uuid": "<string>",
"last_engaged_at": "<string>",
"name": "<string>",
"path_power_score": 123
}
]
}
]
}Person
Lookup a person
Searches across tenant-visible persons (including global records). At least
one of email, linkedin_url, domain, or name must be provided. Returns up to
limit matches (default 5, max 20), ranked so tenant-specific records
appear before global ones.
Parameters:
- email: Matches any of the person’s emails (case/whitespace-insensitive)
- linkedin_url: LinkedIn profile URL (e.g. ‘https://linkedin.com/in/johndoe’)
- domain: Email domain to match — e.g. ‘acme.com’ matches ‘alice@acme.com’
- name: Fuzzy (trigram similarity) match on display name, e.g. for deduping
name-only lists such as conference rosters. Unlike the other criteria this
is not an exact key — several people can match. Results are ranked by
similarity_score; use it alongsidecompany_name/job_title/location to decide whether a candidate is the same person before creating a new record. - limit: Max results to return (default: 5, max: 20)
GET
/
v1
/
persons
/
lookup
Look up a person by email address, LinkedIn URL, email domain, or name.
curl --request GET \
--url https://production-api.joinrings.com/v1/persons/lookup \
--header 'x-api-key: <api-key>'import requests
url = "https://production-api.joinrings.com/v1/persons/lookup"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://production-api.joinrings.com/v1/persons/lookup', 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://production-api.joinrings.com/v1/persons/lookup",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://production-api.joinrings.com/v1/persons/lookup"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://production-api.joinrings.com/v1/persons/lookup")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.joinrings.com/v1/persons/lookup")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"count": 123,
"matches": [
{
"email": "<string>",
"last_activity_date": "<string>",
"linkedin_url": "<string>",
"name": "<string>",
"uuid": "<string>",
"city": "<string>",
"company_name": "<string>",
"country": "<string>",
"current_company": {
"company_name": "<string>",
"logo_url": "<string>",
"uuid": "<string>",
"job_type": "<string>",
"source": "<string>"
},
"current_company_domain": "<string>",
"current_company_name": "<string>",
"current_job_title": "<string>",
"description": "<string>",
"email_last_seen": "<string>",
"entity_lists": [
{
"name": "<string>",
"uuid": "<string>"
}
],
"is_primary_company_recommended": true,
"job_changed_at": "<string>",
"job_title": "<string>",
"last_contact_at": "<string>",
"logo_url": "<string>",
"my_next_meeting_at": "<string>",
"my_next_meeting_title": "<string>",
"next_meeting_at": "<string>",
"next_meeting_title": "<string>",
"next_meeting_with_user_uuid": "<string>",
"pathpower": {
"meta": {},
"score": 123,
"strength_label": "<string>"
},
"previous_job_ended_at": "<string>",
"secondary_email": "<string>",
"secondary_email_last_seen": "<string>",
"similarity_score": 123,
"state": "<string>",
"strongest_relationships": [
{
"internal_user_person_uuid": "<string>",
"internal_user_uuid": "<string>",
"last_engaged_at": "<string>",
"name": "<string>",
"path_power_score": 123
}
]
}
]
}