Read-onlyReferralsMCP tool
referrals_list
Search for referrals by name, status, type, or date range.
Search for referrals by name, status, type, or date range. Returns pagination info (total_count, has_more, offset, limit). Results include: id, display_id, referred_name, referred_email, referring_agent_name, receiving_agent_name, referral_type, status, referral_fee_percentage, created_at. Filter by status (submitted/accepted/active/closed/paid/declined/expired), type (buyer/seller/both), or date range. For a specific referral by ID, use referrals_get instead. For aggregate stats, use referrals_stats.
Parameters#
| Parameter | Type | Required | Description |
|---|---|---|---|
query | string | No | Search term - matches against referred_name, referred_email, referring_agent_name, receiving_agent_name (case-insensitive partial match) |
status | enum | No | Filter by status. submitted=new, accepted=agreed, active=in progress, closed=transaction closed, paid=fee collected, declined=rejected, expired=timed out (default: all) · One of: all, submitted, accepted, active, closed, paid, declined, expired |
referral_type | enum | No | Filter by referral type (default: all) · One of: all, buyer, seller, both |
date_from | string | No | Show referrals submitted on or after this date (Format: YYYY-MM-DD) · Format: Date (YYYY-MM-DD) |
date_to | string | No | Show referrals submitted on or before this date (Format: YYYY-MM-DD) · Format: Date (YYYY-MM-DD) |
archived | boolean | No | Include archived referrals (default: false) |
limit | number | No | Maximum results (default: 50, max: 500) · Max: 500 · Min: 1 |
offset | number | No | Skip N results for pagination (default: 0) · Min: 0 |
Example prompts#
- "Show me all my active referrals and which agents are working them."
- "List referrals I submitted this quarter that have not been paid yet."
Safety#
Read-only. This tool never changes your data — it only looks things up. Safe to run anytime.