Get Referrals

POST 
/v1/referrals/partner/referrals

Find referrals for a prospect based on their LinkedIn URL. The prospect's profile will be automatically enriched via LinkedIn sources to gather complete work history for accurate referral matching against your champions.

Request Body

Field	Type	Description	Required
customer_id	string	The ID of the customer whose champion network to search against.	✅ Yes
prospect_linkedin_url	string	The LinkedIn profile URL of the prospect to find referrals for.	✅ Yes

---

Example Request (JSON)

{
  "customer_id": "cust_abc123",
  "prospect_linkedin_url": "https://linkedin.com/in/prospect"
}

---

Response

The response returns a list of referrals found for the prospect, including champion information, referral scores, and descriptions.

Example Success Response

{
  "referrals": [
    {
      "champion": {
        "linkedin_url": "https://linkedin.com/in/johndoe",
        "first_name": "John",
        "last_name": "Doe"
      },
      "score": 85.5,
      "description": "John worked with the prospect at Tech Corp for 2 years."
    }
  ]
}

---

Error Handling

The API returns appropriate error messages with status codes if something goes wrong.

Error Code	Message	Description
400	Invalid Request	Verify your request is properly formatted
401	Unauthorized	Verify you are using a valid API key
500	Internal Server Error	An unexpected error occurred.

Example Error Response

{
  "error": {
    "code": 400,
    "message":"prospect_linkedin_url is required"
  }
}

Request

Responses

200

Successful response