Skip to main content
GET
List logged intros: introductions that already happened.

Authorizations

x-api-key
string
header
required

Query Parameters

page
integer
default:1

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

per_page
integer
default:10

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

after
string | null

Opaque cursor from a previous response's next_cursor. When supplied, the page starts immediately after the last record of that response and page is ignored — unlike page, this cannot skip or repeat records when the data changes mid-scan. Filters and sort must stay identical for the whole scan; changing one is a 400. Not supported by every list endpoint — those that support it return next_cursor.

entity_uuid
string | null

Only intros involving this person, company or opportunity, in any role unless role is set. Use with order=asc to find how the firm first met someone.

role
enum<string> | null

With entity_uuid: only intros where that entity had this role.

Available options:
INTRODUCER,
INTRODUCED,
INTRODUCED_TO
introducer_uuid
string | null

Only intros made by this person or company. Combines with entity_uuid, e.g. did Jane introduce us to Acme?

direction
enum<string> | null

Only INBOUND or OUTBOUND intros.

Available options:
INBOUND,
OUTBOUND
date_from
string | null

Intro date on or after this day, YYYY-MM-DD.

date_to
string | null

Intro date on or before this day, YYYY-MM-DD.

has_outcome
boolean | null

false: only intros still pending an outcome. true: only intros with an outcome.

outcome
string | null

Only intros with this outcome (label or UUID).

source_type
string | null

Only intros with this source type (label or UUID).

source
enum<string> | null

How the record entered Rings: MANUAL (logged by a person or agent), EMAIL_EXTRACTION (found in email), MIGRATED.

Available options:
MANUAL,
EMAIL_EXTRACTION,
MIGRATED
order
enum<string>
default:desc

Sort by intro date. desc (default) = newest first.

Available options:
asc,
desc

Response

200 - application/json

IntroListResponse(items: list[rcp_api.rest.schemas.intro.IntroResponse], page: int, per_page: int, total: int | None, next_cursor: str | None = None, has_more: bool | None = None)

items
IntroResponse · object[]
required
page
integer
required
per_page
integer
required
total
integer | null
required
has_more
boolean | null
next_cursor
string | null