Skip to main content
GET
List received referrals

Authorizations

X-API-Key
string
header
required

Public API key: cxp_<hex> (firm-scoped) or cxpp_<hex> (provider-scoped). Required on every request.

Query Parameters

page
integer
default:1

Page number (1-indexed)

Required range: x >= 1
limit
integer
default:20

Results per page (max 100)

Required range: 1 <= x <= 100
status
enum<string>

Filter by CaseStatus. 'terminated' and 'exhausted' are rejected with 400: they are the sending firm's private categorization of a rejected referral, not referral statuses.

Available options:
draft,
sent,
received,
under_evaluation,
investigating,
signed,
in_litigation,
closing,
won,
lost,
closed,
rejected,
withdrawn,
pending_spin_off
closingStatus
enum<string>

Filter by ClosingStatus (case-insensitive)

Available options:
won_settled,
lost,
no_longer_pursuing

Case-insensitive substring match on reference number or sending firm name

Maximum string length: 255
sort
enum<string>

Sort field (default updatedAt). Ties are broken by referral id.

Available options:
updatedAt,
createdAt,
status,
referenceNumber
order
enum<string>

Sort direction (default desc, case-insensitive)

Available options:
asc,
desc
firmId
string<uuid>

Admin-global keys only: narrow the cross-firm list to referrals received by this firm. Ignored for firm-scoped keys, which are always filtered to their own firm.

Response

Paginated list of received referrals

data
object[]
required
pagination
object
required
meta
object
required