Skip to main content
GET
Read a single opportunity by the ID that search results return. This is where the notes written by Update Opportunity come back: notes are stored on the opportunity and are returned here and in the tracking block on search results, nowhere else.
To append to a note, read it first. notes on the update endpoint replaces whatever is there. Fetch the current value here, concatenate, and send the combined text back.
Where an intro stands with your team is a tag. Read it with Get An Opportunity’s Tags.
For how well two people’s titles line up, read relationship.sharedWorkExperiences[].roleAlignmentTier.

Response

The opportunity in the same shape the searches return it, plus the connector it came through. The tracking object is present once notes or an assignment have been set. It is where an intro stands with your team, and is separate from Workflows, the automation builder in the app:

Authorizations

Authorization
string
header
required

The API key you created on the API settings page of the Clustr app.

Headers

X-Clustr-Fresh
enum<string>

Send 1 for about 10 seconds after a write of your own: the read waits up to queries.clickhouse.write_wait_ms (default 6 s) for that write and is never answered from a last-good copy. Do not send it on every request.

Available options:
1

Path Parameters

intro_id
string
required

Response

Typed result envelope.

success
boolean
required
data
object
required