Skip to main content
GET
List messages

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.

Path Parameters

referral_id
string
required
Example:

"ref_01K5X3K7Q2"

Query Parameters

author
enum<string>

Only return messages from this author.

Available options:
oj,
borrower,
partner
channel
enum<string>

Only return messages that went through this channel. Where a message went through. embed is the O.J. Embed component inside your product. hosted_page is an O.J.-hosted page. sms, imessage, email and voice are O.J.'s own channels, used only when your policy allows them. partner_channel means O.J. delivered through one of your channel connectors, in your brand. api means the message was posted by your system, your agent, or an A2A client.

Available options:
embed,
hosted_page,
sms,
imessage,
email,
voice,
partner_channel,
api
after
string

Only return messages created after the message with this id.

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 messages

data
object[]
required
has_more
boolean
required