Skip to content

All DMs between me and a specific peer

GET
/account/messages/{peer_ref}

Cursor-paginated newest-first. Caller must be one of the two participants (gate enforced by the WHERE clause — no separate “is this thread mine?” check needed). 404 when the peer doesn’t exist.

peer_ref
required
integer format: int64
limit
integer
default: 50 >= 1 <= 200
cursor
string

A page of messages.

object
items
required
Array<object>

One DM between two users.

object
id
required
string format: uuid
sender_user_ref
required
integer format: int64
recipient_user_ref
required
integer format: int64
body
required
string
sent_at
required
string format: date-time
read_at

NULL = unread by recipient.

string format: date-time
nullable
next_cursor
string
nullable

Authentication required, missing, or invalid

object
error
required

Human-readable error summary

string
Example
the request could not be completed
Example
{
"error": "authentication required: sign in and retry with a valid session or API token"
}

Resource not found

object
error
required

Human-readable error summary

string
Example
the request could not be completed