Skip to main content
GET
List events

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

type
enum<string>

Only return events of this type. The kinds of events O.J. sends. The name is object.what_happened. The Webhooks section of the docs explains when each one fires.

Available options:
referral.received,
referral.matches_updated,
referral.needs_partner,
referral.needs_borrower,
message.sent,
message.received,
referral.reminder_due,
submission.awaiting_review,
submission.decided,
document_request.opened,
document_request.satisfied,
referral.submitted,
offer.received,
offer.accepted,
referral.funded,
referral.declined,
referral.closed,
payout.updated
referral_id
string

Only return events for this referral.

created_after
string<date-time>

Only return events that happened after this time. Use the created_at of the last event you processed.

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 events

data
object[]
required
has_more
boolean
required