Skip to main content
GET
Get recommended relationship paths to a person — the primary tool for

Authorizations

x-api-key
string
header
required

Path Parameters

person_uuid
string
required

Query Parameters

page
integer
default:1

Page number, 1-indexed. Clamped to >= 1.

per_page
integer
default:50

Results per page. Clamped to the range 1-100 (values outside are silently capped, not rejected).

sort_by
enum<string> | null

Field to sort by. Valid values: 'score', 'name'

Available options:
score,
name
order
enum<string>
default:desc

Sort order. Default: 'desc' (highest score first)

Available options:
asc,
desc

Response

200 - application/json

Paginated recommended paths response.

items
RecommendedContact · object[]
required
page
integer
required
per_page
integer
required
total
integer
required
target_logo_url
string | null
target_name
string | null
target_uuid
string | null
top_external_contacts
TopExternalContact · object[] | null