Skip to main content
GET
List referrals

Authorizations

Authorization
string
header
required

One client per partner per environment. Access tokens expire after 15 minutes. Scopes are granted per client. Sandbox clients use https://sandbox.api.meet-oj.com/oauth/token.

Query Parameters

status
enum<string>

Only return referrals in this status. Where the referral is, for logic. Use progress and status_label for anything a person reads.

The normal path is received, then prequalified once the business has matches, then submitted when the file has gone to lenders, then offer when a lender has made one, then funded. A referral pauses in needs_borrower when the borrower has a to-do, or needs_partner when someone at your company does.

Two statuses are final. declined means a lender reviewed the file and did not approve it; the lender, not O.J., sends the borrower its notice. closed means the referral ended without a lender decision, for example because no lender matched, the borrower withdrew, or the business funded elsewhere.

Available options:
received,
prequalified,
needs_partner,
needs_borrower,
submitted,
offer,
funded,
declined,
closed
external_id
string

Only return the referral you created with this external_id (your own identifier for the business).

created_after
string<date-time>

Only return referrals created after this time.

limit
integer
default:25
Required range: 1 <= x <= 100
starting_after
string

Cursor — the id of the last object on the previous page.

Response

200 - application/json

A page of referrals

data
object[]
required
has_more
boolean
required