---
title: "List your partner referrals"
url: https://docs.corefinity.com/api/reference/agency/list-agency-referrals
type: endpoint
last_updated: 2026-11-13
feature: agency
related:
  - https://docs.corefinity.com/guides/agencies/agency-portal.md
  - https://docs.corefinity.com/mcp/tools/corestack_agency_referrals_list.md
---
# 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.

```http
GET /api/agency/referrals
```

- Scope: `read`
- Rate limit: 60 a minute
- Try it in the console: on

## Query parameters

- `limit` (integer): Items a page.
- `cursor` (string): The `next_cursor` of the previous answer. It is a page number as a string of digits; anything else is refused `422` on `cursor`.
- `search` (string): Part of a company name or website address. Up to 255 characters.

## Request

### curl

```bash
curl https://manage.corefinity.com/api/agency/referrals \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
```

### PHP

```php
use Illuminate\Support\Facades\Http;

$response = Http::withToken(env('COREFINITY_TOKEN'))
    ->acceptJson()
    ->get('https://manage.corefinity.com/api/agency/referrals');

$data = $response->json();
```

### Node

```javascript
const res = await fetch('https://manage.corefinity.com/api/agency/referrals', {
  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);
```

### Python

```python
import os
import requests

res = requests.get(
    "https://manage.corefinity.com/api/agency/referrals",
    headers={
        "Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
        "Accept": "application/json",
    },
)

data = res.json() if res.content else None
```

## Responses

### 200 One page of referrals.

```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": "eleanor.finch@harbourandfinch.example.com",
        "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
  }
}
```

### 401 No token, or a token that is not valid.

```json
{
  "message": "Unauthenticated."
}
```

### 403 The token lacks the `read` scope (`scope_required`), or your role may not view partner referrals (`forbidden`).

```json
{
  "code": "forbidden",
  "message": "You are not allowed to view partner referrals.",
  "reason": "forbidden",
  "status": "error"
}
```

### 422 A `limit` outside 1 to 100, a `cursor` the list did not give you, or a `search` that is too long (`invalid`).

```json
{
  "code": "invalid",
  "errors": {
    "limit": [
      "The limit may not be greater than 100."
    ]
  },
  "field": "limit",
  "message": "The limit may not be greater than 100.",
  "reason": "invalid"
}
```

### 429 Too many requests (`rate_limited`). Wait for the number of seconds in `Retry-After`, which `retry_after_seconds` repeats.

```json
{
  "code": "rate_limited",
  "message": "Too many requests. Try again in 60 seconds.",
  "reason": "rate_limited",
  "retry_after_seconds": 60
}
```

## If it is refused

| Status | Reason | What to do |
|---|---|---|
| 401 |  | 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`. |
| 422 | `invalid` | Fix the field named in `field`; `errors` says why. |
| 429 | `rate_limited` | Wait for the seconds in `Retry-After`. |

## The same task elsewhere

- Guide: [Agency portal](https://docs.corefinity.com/guides/agencies/agency-portal.md)
- MCP tool: [`corestack_agency_referrals_list`](https://docs.corefinity.com/mcp/tools/corestack_agency_referrals_list.md)
