CorefinityCorefinityDocs
Open the Control PanelControl Panel
Agency · 5 of 7

List your partner referrals

The leads your agency has referred to Corefinity, newest first. Your role needs the viewAgencyLeads permission. Paged by cursor: send next_cursor back as cursor; null means the last page.

GET/api/agency/referrals

Query parameters

limitinteger

Items a page. Defaults to 25. 1 to 100.

cursorstring

The next_cursor of the previous answer. It is a page number as a string of digits; anything else is refused 422 on cursor.

searchstring

Part of a company name or website address. Up to 255 characters.

Returns

200 One page of referrals.

Fields of the 200 answer
dataobjectRequired

The paging field of a cursor-paged list. The list itself sits beside it under a key each endpoint names, such as items or sites.

Fields
next_cursorstring or nullRequired

Send as cursor to read the next page. Null on the last page.

itemsarray of objectsRequired
Fields of each item
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
emailphonenull
website_urlstringRequired

The lead's website, as it was typed. The scheme is optional.

If it is refused

StatusReasonWhat to do
401noneSend a valid token as Authorization: Bearer <token>.
403forbiddenThe person is not allowed to do this.
403scope_requiredUse a token with the scope named in scope.
422invalidFix the field named in field; errors says why.
429rate_limitedWait 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 \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "data": {
    "items": [
      {
        "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"
      }
    ],
    "next_cursor": null
  }
}
Try it
Held in this tab's memory only. Never stored or sent to us.

Use a token with only the read scope. How to make one

Was this helpful?
Open in ClaudeOpen in ChatGPT