Get a partner referral
One of your agency's referrals. Another agency's referral answers the same 404 as an id that does not exist.
GET/ api/ agency/ referrals/ {referral}
Path parameters
referralintegerRequired
The id of one of your agency's referrals. Digits only. At least 1.
Returns
200 The referral.
Fields of the 200 answer
dataobjectRequired
A lead your agency referred to Corefinity.
Fields
company_namestringRequired
contact_leadbooleanRequired
Whether Corefinity may contact the lead directly.
created_atstring or nullRequired
Format: date-time.
current_costnumber or nullRequired
What the lead pays for hosting today.
current_providerstring or nullRequired
Who hosts the lead today.
idintegerRequired
At least 1.
main_contact_emailstring or nullRequired
main_contact_mobilestring or nullRequired
The mobile number in international form, such as +447700900123.
main_contact_mobile_countrystring or nullRequired
The two-letter country code the number was read with.
main_contact_namestring or nullRequired
notesstring or nullRequired
Your notes. When Corefinity may contact the lead and the contact's mobile or email is missing, a line saying so is added.
preferred_contact_methodstring or nullRequired
emailphonenullwebsite_urlstringRequired
The lead's website, as it was typed. The scheme is optional.
If it is refused
| Status | Reason | What to do |
|---|---|---|
401 | none | Send a valid token as Authorization: Bearer <token>. |
403 | forbidden | The person is not allowed to do this. |
403 | scope_required | Use a token with the scope named in scope. |
404 | none | Check the id. You see only what your account can reach. |
429 | rate_limited | Wait for the seconds in Retry-After. |
Reasons are listed by name in Errors and refusals.
The same task elsewhere
curl https://manage.corefinity.com/api/agency/referrals/3120 \
-H "Authorization: Bearer $COREFINITY_TOKEN" \
-H "Accept: application/json"use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->get('https://manage.corefinity.com/api/agency/referrals/3120');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/agency/referrals/3120', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
Accept: 'application/json',
},
});
// An answer with no body (204) has nothing to parse.
const text = await res.text();
const data = text && JSON.parse(text);import os
import requests
res = requests.get(
"https://manage.corefinity.com/api/agency/referrals/3120",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"data": {
"company_name": "Harbour & Finch",
"contact_lead": true,
"created_at": "2026-11-09T10:15:00Z",
"current_cost": 120.5,
"current_provider": "Another host",
"id": 3120,
"main_contact_email": "[email protected]",
"main_contact_mobile": "+447700900123",
"main_contact_mobile_country": "GB",
"main_contact_name": "Eleanor Finch",
"notes": "Moving this quarter.",
"preferred_contact_method": "phone",
"website_url": "https://harbourandfinch.example.com"
}
}{
"message": "Unauthenticated."
}{
"code": "forbidden",
"message": "You are not allowed to view partner referrals.",
"reason": "forbidden",
"status": "error"
}{
"message": "Not found."
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}Try it
Was this helpful?