Skip to main content
GET
List referrals

Authorizations

x-api-key
string
header
required

Org-issued integration API key (service account credential). The plaintext secret is shown once at creation.

Query Parameters

after
string
Minimum string length: 1
limit
integer
default:100
Required range: 1 <= x <= 500
direction
enum<string>
Available options:
in,
out
status
enum<string>
Available options:
unmatched,
acknowledged,
matched,
referred_out,
canceled,
rejected
caseId
string
Required string length: 1 - 200

Response

{ success: true, referrals: [...], nextCursor }

success
boolean
required
{key}
any