---
title: "Get a partner referral"
url: https://docs.corefinity.com/api/reference/agency/get-agency-referral
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_referral_get.md
---
# 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.

```http
GET /api/agency/referrals/{referral}
```

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

## Path parameters

- `referral` (integer, required): The id of one of your agency's referrals. Digits only.

## Request

### curl

```bash
curl https://manage.corefinity.com/api/agency/referrals/3120 \
  -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/3120');

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

### Node

```javascript
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);
```

### Python

```python
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
```

## Responses

### 200 The referral.

```json
{
  "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": "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"
  }
}
```

### 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"
}
```

### 404 The id does not exist, or it is something you cannot see. Both answer the same body.

```json
{
  "message": "Not found."
}
```

### 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`. |
| 404 |  | Check the id. You see only what your account can reach. |
| 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_referral_get`](https://docs.corefinity.com/mcp/tools/corestack_agency_referral_get.md)
