Get recommended relationship paths to a person — the primary tool for
curl --request GET \
--url https://production-api.joinrings.com/v1/persons/{person_uuid}/recommended-paths \
--header 'x-api-key: <api-key>'import requests
url = "https://production-api.joinrings.com/v1/persons/{person_uuid}/recommended-paths"
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/{person_uuid}/recommended-paths', 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/{person_uuid}/recommended-paths",
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/{person_uuid}/recommended-paths"
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/{person_uuid}/recommended-paths")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.joinrings.com/v1/persons/{person_uuid}/recommended-paths")
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{
"items": [
{
"person_uuid": "<string>",
"company_name": "<string>",
"connection_score": 123,
"email": "<string>",
"emails": [
{
"address": "<string>",
"is_primary": false,
"last_seen_at": "<string>"
}
],
"facebook_url": "<string>",
"is_internal": true,
"is_primary_company_recommended": true,
"job_title": "<string>",
"linkedin_url": "<string>",
"logo_url": "<string>",
"name": "<string>",
"path_count": 0,
"paths": [
[
{
"person_uuid": "<string>",
"associations": [
"<string>"
],
"company_name": "<string>",
"connection_score": 123,
"interaction_count": 123,
"job_title": "<string>",
"last_interaction_at": "<string>",
"linkedin_url": "<string>",
"logo_url": "<string>",
"name": "<string>",
"ring_key": "<string>",
"ring_name": "<string>"
}
]
],
"primary_company": {
"logo_url": "<string>",
"name": "<string>",
"uuid": "<string>"
},
"priority_management": [
{
"interaction_count": 123,
"last_activity_date": "<string>",
"person_uuid": "<string>",
"priority_context": [
{}
],
"priority_score": 123,
"rq": 123,
"rq_manual": 123,
"rq_pretty": 123,
"rq_reason": "<string>",
"signal_metadata": {
"associations": 0,
"lists": 0
},
"user_logo_url": "<string>",
"user_name": "<string>",
"user_uuid": "<string>"
}
],
"signal_metadata": {
"associations": 0,
"lists": 0
},
"strength": "<string>",
"tags": [
"<string>"
],
"twitter_url": "<string>"
}
],
"page": 123,
"per_page": 123,
"total": 123,
"target_logo_url": "<string>",
"target_name": "<string>",
"target_uuid": "<string>",
"top_external_contacts": [
{
"person_uuid": "<string>",
"connection_score": 123,
"email": "<string>",
"internal_connectors": [
{
"internal_user_person_uuid": "<string>",
"internal_user_uuid": "<string>",
"last_engaged_at": "<string>",
"name": "<string>",
"path_power_score": 123
}
],
"job_title": "<string>",
"name": "<string>",
"strength": "<string>",
"tags": [
"<string>"
]
}
]
}Recommended Paths
Recommended paths to a person
“who knows this person” / “introduce me to” / “path to” queries.
Returns internal team members ranked by connection strength, each with 2-hop relationship paths showing how they connect to the target person. Use this instead of PathPower when you need actual introduction paths, not just a score.
Each result includes the connector’s name, relationship quality (rq), and the path hops linking them to the target.
GET
/
v1
/
persons
/
{person_uuid}
/
recommended-paths
Get recommended relationship paths to a person — the primary tool for
curl --request GET \
--url https://production-api.joinrings.com/v1/persons/{person_uuid}/recommended-paths \
--header 'x-api-key: <api-key>'import requests
url = "https://production-api.joinrings.com/v1/persons/{person_uuid}/recommended-paths"
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/{person_uuid}/recommended-paths', 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/{person_uuid}/recommended-paths",
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/{person_uuid}/recommended-paths"
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/{person_uuid}/recommended-paths")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.joinrings.com/v1/persons/{person_uuid}/recommended-paths")
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{
"items": [
{
"person_uuid": "<string>",
"company_name": "<string>",
"connection_score": 123,
"email": "<string>",
"emails": [
{
"address": "<string>",
"is_primary": false,
"last_seen_at": "<string>"
}
],
"facebook_url": "<string>",
"is_internal": true,
"is_primary_company_recommended": true,
"job_title": "<string>",
"linkedin_url": "<string>",
"logo_url": "<string>",
"name": "<string>",
"path_count": 0,
"paths": [
[
{
"person_uuid": "<string>",
"associations": [
"<string>"
],
"company_name": "<string>",
"connection_score": 123,
"interaction_count": 123,
"job_title": "<string>",
"last_interaction_at": "<string>",
"linkedin_url": "<string>",
"logo_url": "<string>",
"name": "<string>",
"ring_key": "<string>",
"ring_name": "<string>"
}
]
],
"primary_company": {
"logo_url": "<string>",
"name": "<string>",
"uuid": "<string>"
},
"priority_management": [
{
"interaction_count": 123,
"last_activity_date": "<string>",
"person_uuid": "<string>",
"priority_context": [
{}
],
"priority_score": 123,
"rq": 123,
"rq_manual": 123,
"rq_pretty": 123,
"rq_reason": "<string>",
"signal_metadata": {
"associations": 0,
"lists": 0
},
"user_logo_url": "<string>",
"user_name": "<string>",
"user_uuid": "<string>"
}
],
"signal_metadata": {
"associations": 0,
"lists": 0
},
"strength": "<string>",
"tags": [
"<string>"
],
"twitter_url": "<string>"
}
],
"page": 123,
"per_page": 123,
"total": 123,
"target_logo_url": "<string>",
"target_name": "<string>",
"target_uuid": "<string>",
"top_external_contacts": [
{
"person_uuid": "<string>",
"connection_score": 123,
"email": "<string>",
"internal_connectors": [
{
"internal_user_person_uuid": "<string>",
"internal_user_uuid": "<string>",
"last_engaged_at": "<string>",
"name": "<string>",
"path_power_score": 123
}
],
"job_title": "<string>",
"name": "<string>",
"strength": "<string>",
"tags": [
"<string>"
]
}
]
}Authorizations
Path Parameters
Query Parameters
Page number, 1-indexed. Clamped to >= 1.
Results per page. Clamped to the range 1-100 (values outside are silently capped, not rejected).
Field to sort by. Valid values: 'score', 'name'
Available options:
score, name Sort order. Default: 'desc' (highest score first)
Available options:
asc, desc Response
200 - application/json
Paginated recommended paths response.
⌘I