Skip to main content
GET
List the calling user's own relationships, ranked by their RQ.

Authorizations

x-api-key
string
header
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
string | null

Field to sort by. Common values: 'relationship_quality', 'priority_score', 'last_activity_date' (default), 'company_score', 'person_name', 'company_name' — but any column name in the MRR parquet schema works (e.g. 'job_title', 'oldest_signal_created_at'). 'relationship_quality'/'priority_score' are aliases for the underlying 'highest_rq'/'highest_priority_score' columns. An unrecognized value silently falls back to 'last_activity_date' rather than erroring.

order
enum<string>
default:desc

Sort order. Valid values: 'asc' (ascending) or 'desc' (descending).

Available options:
asc,
desc
relationship_quality
string | null

Comma-separated integers (1-3) to filter by exact match against each person's highest Relationship Quality (RQ) score across the ring.

priority_score
string | null

Comma-separated integers (1-3) to filter by exact match against each person's highest Priority Score across the ring.

company_score_from
integer | null

Filter by the person's primary company's AI score (company_score). Exclusive bound: matches scores strictly greater than this value (not >=).

company_score_to
integer | null

Filter by the person's primary company's AI score (company_score). Exclusive bound: matches scores strictly less than this value (not <=).

Response

200 - application/json

RingRelationshipsResponse(items: list[dict[str, typing.Any]], page: int, per_page: int, total: int | None = None)

items
Items · object[]
required
page
integer
required
per_page
integer
required
total
integer | null